From 43e7495b260544de946ae2b900900b4cc6de779e Mon Sep 17 00:00:00 2001 From: gryf Date: Sat, 4 May 2019 11:11:49 -0600 Subject: [PATCH] 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. --- README.md | 8 +++++++- _config.yml | 2 ++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 723489b..85e0454 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ files accepted by [Jekyll](https://jekyllrb.com) static site generator. 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. If your distribution doesn't contain it (even in external ones, like PPA for @@ -18,9 +19,14 @@ typical usage would be as follows: ``` $ cd window-maker.github.io && bundler init $ bundler add jekyll +$ mkdir _plugins +$ git clone https://github.com/gryf/jekyll-rst _plugins/jekyll-rst $ bundler exec jekyll serve ``` +Consult [jekyll-rst](https://github.com/gryf/jekyll-rst) plugin documentation +for requirements. + which 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 diff --git a/_config.yml b/_config.yml index 5af0498..088b618 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,3 @@ title: Window Maker +rst: + initial_header_level: 1