diff --git a/README.md b/README.md index 42f47bd..6014799 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Rust Playground Highlight Blocks -Automatically add links to the Rust Playground for code samples in your Jekyll site. +Automatically add links to the Rust Playground for code samples in your Jekyll site, so that they look like this: @@ -8,10 +8,6 @@ Automatically add links to the Rust Playground for code samples in your Jekyll s You can link two different kinds of Rust Playground pages -- dynamically generated & gist generated -## Requirements - -I am using this with Jekyll 2.5.3. It *should* work with Jekyll 3 - ### Dynamically Generated The content of your block appears in the Rust Playground exactly as it appears. This takes advantage of Rust Playground's support for displaying code via URL query strings. @@ -48,6 +44,10 @@ With Gist Generated blocks only the code in the Gist is displayed in the Playgro In the example above, I've left the `main` function out of the sample code, but it is present in the [Playground](https://play.rust-lang.org/?gist=cc6e026b0654a4216074&version=stable) +## Requirements + +I am using this with Jekyll 2.5.3. It *should* work with Jekyll 3 + ## Limitations - Links always point to the stable Rust channel. Support for Beta or Nightly would be nice.