Usage
=====

Initialization
--------------

Pub2 requires Jekyll to work.
In the root directory of a Jekyll project, run the init command.

::

    pub2 init

The init command will create the following files:

- /_pub2
- /_pages/pub2.html

The next time the Jekyll site is rebuilt, these files will be detected.

Pre-requisite: Jekyll
^^^^^^^^^^^^^^^^^^^^^

You can quickly scaffold a Jekyll website using `diamond-patterns <https://diamond-patterns.readthedocs.io>`_.

::

    pip install diamond-patterns
    diamond pattern website