pmatulis / praecepta

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Example documentation

This is an example of how to structure a set of Markdown documentation, for building with the documentation builder.

Usage

To build documentation, you first need to install the documentation-builder:

snap install documentation-builder

Now simply run it inside this folder:

documentation-builder

This will build HTML documentation in the build/ directory. You can now view it in a browser by opening build/en/index.html.

About