tristandamron / geocml-docs

User documentation for geoCML

geoCML documentation

This repository hosts the documentation for the geoCML project. geoCML documentation is rendered to HTML and PDF from Asciidoc files (.adoc) using docToolchain. docToolchain requires that you have Docker installed on your system, as builds are rendered inside of a container.

Writing new documentation topics

You may choose to extend the default geoCML documentation (distributed with all geoCML Base Deployments) as you customize your deployment. All Asciidoc topics are found in the project's topics/ directory. Simply add your new topics as a .adoc file to this directory and build using docToolchain's command line tool.

How to build your documentation

*nix / Bash:

Run ./bin/dtcw generateHTML generatePDF

Windows:

Run "./bin/dtcw.bat" generateHTML generatePDF