1
0
mirror of https://github.com/gryf/jekyll-rst.git synced 2025-12-18 20:10:20 +01:00

Updated description about this fork

(cherry picked from commit 3566454404da4515339bf0c01ba2fc2828965e3f)
This commit is contained in:
niktwenty3
2018-07-19 02:24:18 +02:00
committed by Roman Dobosz
parent e74e57e12e
commit fe2e42d324

View File

@@ -1,10 +1,14 @@
Overview
========
This plugin adds `ReStructuredText`_ support to `Jekyll`_ and `Octopress`_.
This plugin is a fork of `jekyll-rst <https://github.com/xdissent/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/
.. _Harry Marr's advice: http://hmarr.com/2010/jan/19/making-virtualenv-play-nice-with-git/