Files
window-maker.github.io/README.md
gryf 43e7495b26 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.
2019-05-15 21:57:27 +02:00

1.2 KiB

Window Maker webpage source

This is a web page source files. All of the files should be proper markdown files accepted by Jekyll static site generator.

Build/serve

In order to build the site, you'll need Jekyll framework installed and 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 Ubuntu, AUR for Arch or some portage overlay from Gentoo), that it might be installed locally using Bundler, which 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 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 it's page