From fe2e42d3241e91a464c2f82aec8eed4f96f4e729 Mon Sep 17 00:00:00 2001 From: niktwenty3 Date: Thu, 19 Jul 2018 02:24:18 +0200 Subject: [PATCH] Updated description about this fork (cherry picked from commit 3566454404da4515339bf0c01ba2fc2828965e3f) --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 48c21f4..78d3fe3 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,14 @@ Overview ======== -This plugin adds `ReStructuredText`_ support to `Jekyll`_ and `Octopress`_. +This plugin is a fork of `jekyll-rst `_ that adds `ReStructuredText`_ support to `Jekyll`_ and `Octopress`_. It renders ReST in posts and pages, and provides a custom directive to support Octopress-compatible syntax highlighting. +This version supports rst2html5 conversion but hasn't been tested for Octopress compatability. + +The main change on this fork is that since rst2html5 doesn't return **parts** like rst2html does this verions uses Nokogiri to extract the body contents. + Requirements ============ @@ -94,4 +98,4 @@ Octopress Tips .. _Octopress: http://octopress.com/ .. _RbST: http://rubygems.org/gems/RbST .. _bundler: http://gembundler.com/ -.. _Harry Marr's advice: http://hmarr.com/2010/jan/19/making-virtualenv-play-nice-with-git/ \ No newline at end of file +.. _Harry Marr's advice: http://hmarr.com/2010/jan/19/making-virtualenv-play-nice-with-git/