Guides

Getting started

This section describes how to use the commandline tool and how to configure it. The commandline tool is a small wrapper around the core library and can be used to render RST and Markdown files to HTML.

Create your first documentation

After Installation you can directly start to create your first documentation. to do this, create a new directory named docs and create a file called index.rst in it.

My first documentation
======================

This is my first documentation. It is written in reStructuredText.

.. toctree::
    :maxdepth: 2

    chapter1
    chapter2

Now run the command to render the documentation:

$ ./vendor/bin/guides docs

You will find the output in the output directory and it should look like this:

Example index file rendered to HTML

Now you can start to write your documentation or read the Configuration section to learn more about the configuration.

Extending

Like any other component in this repository, the commandline tool can be extended. This can be done using an extension class, and referencing this class in the configuration file, like shown for in the Extension configuration section.

Search results