Added jekyll-rst plugin.

jekyll-rst plugin allows to use restructured text source files, which
are much convinient than plain markdown files, since reST format
supports ootb:

- tables
- definitions
- code highlight
- autogenerated table of content

and much more.
This commit is contained in:
2019-05-04 11:11:49 -06:00
parent 499c608e76
commit 67c1516096
2 changed files with 14 additions and 3 deletions

View File

@@ -7,7 +7,8 @@ files accepted by [Jekyll](https://jekyllrb.com) static site generator.
Build/serve Build/serve
----------- -----------
In order to build the site, you'll need Jekyll framework installed. Easiest way In order to build the site, you'll need Jekyll framework installed and
[jekyll-rst](https://github.com/gryf/jekyll-rst) plugin. Easiest way
to achieve it, is to install it from system repositories. to achieve it, is to install it from system repositories.
If your distribution doesn't contain it (even in external ones, like PPA for If your distribution doesn't contain it (even in external ones, like PPA for
@@ -18,10 +19,18 @@ typical usage would be as follows:
``` ```
$ cd window-maker.github.io && bundler init $ cd window-maker.github.io && bundler init
$ bundler add jekyll $ bundler add jekyll
$ mkdir _plugins
$ git clone https://github.com/gryf/jekyll-rst _plugins/jekyll-rst
$ pip install docutils pygments
$ gem install RbST nokogiri
$ bundler exec jekyll serve $ bundler exec jekyll serve
``` ```
which will initialize gemfile, add jekyll to it, and then perform `jekyll serve` Consult [jekyll-rst](https://github.com/gryf/jekyll-rst) plugin documentation
which underneath will build the site and than run simple http server on for requirements. Other options for installing dependencies are also possible -
they might be installed from distribution repositories.
Last line will initialize gemfile, add jekyll to it, and then perform `jekyll
serve` which underneath will build the site and than run simple http server on
`http://localhost:4000` in development mode. More about jekyll you can find [on `http://localhost:4000` in development mode. More about jekyll you can find [on
it's page](https://jekyllrb.com/docs) it's page](https://jekyllrb.com/docs)

View File

@@ -1 +1,3 @@
title: Window Maker title: Window Maker
rst:
initial_header_level: 1