Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
IanWhitney committed Dec 19, 2015
1 parent 62667ce commit 993447a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
# 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:

<img src="http://i.imgur.com/gkFQsHJ.png" />

## Usage

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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 993447a

Please sign in to comment.