Overview

This plugin adds ReStructuredText support to Jekyll and Octopress. It renders ReST in posts and pages, and provides a custom directives to support Octopress-compatible syntax highlighting.

Requirements

• Jekyll or Octopress >= 2.0

• Docutils

• Pygments

• RbST

Installation

1. Install Docutils and Pygments.

   The most convenient way is to use virtualenv_burrito:

   $ curl -s https://raw.github.com/brainsik/virtualenv-burrito/master/virtualenv-burrito.sh | bash
   $ source /Users/xdissent/.venvburrito/startup.sh
   $ mkvirtualenv jekyll-rst
   $ pip install docutils pygments

2. Install RbST.

   If you use bundler with Octopress, add gem 'RbST' to your Gemfile in the development group, then run bundle install. Otherwise, gem install RbST.

3. Install the plugin.

   For Jekyll:

   $ cd <jekyll-project-path>
   $ git submodule add https://github.com/xdissent/jekyll-rst.git _plugins/jekyll-rst

   For Octopress:

   $ cd <octopress-project-path>
   $ git submodule add https://github.com/xdissent/jekyll-rst.git plugins/jekyll-rst

4. Start blogging in ReStructuredText. Any file with the .rst extension will be parsed as ReST and rendered into HTML.

   Note

   Be sure to activate the jekyll-rst virtualenv before generating the site by issuing a workon jekyll-rst. I suggest you follow Harry Marr's advice and create a .venv file that will automatically activate the jekyll-rst virtualenv when you cd into your project.

Octopress Tips

• Use .. more in your ReST documents to indicate where Octopress's excerpt tag should split your content for summary views.