octopress-escape-code

Octopress Escape Code

Automatically escape code blocks so you can use liquid tags without worry having to surround them with unsightly {% raw %} and {% endraw %} tags. This escapes code block created with {% highlight %}, {% codeblock %}, code fences, Markdown indented code blocks, and in-line back tick code tags.

Installation

Using Bundler

Add this gem to your site's Gemfile in the :jekyll_plugins group:

group :jekyll_plugins do
  gem 'octopress-escape-code'
end

Then install the gem with Bundler

$ bundle

Manual Installation

$ gem install octopress-escape-code

Then add the gem to your Jekyll configuration.

gems:
  -octopress-escape-code

Configuration

To escape code blocks on a single page, add this configuration to the page's YAML front-matter.

escape_code: true

If you prefer, you can enable it on a site-wide basis.

// in Jekyll's _config.yml
escape_code: true

Adding escape_code: false any the page's YAML front-matter will disable code escaping for that page.

Usage

Code plugins

Before Jekyll parses your pages and posts through Liquid, code is automatically wrapped with {% raw %} blocks, ensuring that their contents aren't parsed by Liquid. For example, a {% highlight %} block's contents are wrapped like this.

{% highlight html %}{% raw %}
<article>{{ post.content }}</article>
{% endraw %}{% endhighlight %}

The {% highlight %} block is still interpreted by Liquid, but the contents are escaped. This will also escape the Octopress codeblock plugin.

Some Markdown processors and the Octopress codefence plugin render code blocks which are surrounded by three back ticks. These are also wrapped with {% raw %} tags.

{% raw %}
```html
<article>{{ post.content }}</article>
```
{% endraw %}

Liquid sees the raw tags and ignores the contents, but the code fences are still interpreted.

Standard Markdown code

If you are using Markdown, you may create a code blocks by indenting four spaces or a single tab. These code blocks are escaped like this.

{% raw %}
    <article>{{ post.content }}</article>
{% endraw %}

You can also define in-line code tags by surrounding text with back ticks, like this `some code` which are automatically escaped as well.

This inline {% raw %}`<code>`{% endraw %} tag is escaped.

This works with double back tick code tags as well.

Contributing

• Fork it ( https://github.com/octopress/escape-code/fork )
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create a new Pull Request