https://github.com/geocml/docs

User documentation for geoCML
https://github.com/geocml/docs

Last synced: about 1 month ago
JSON representation

User documentation for geoCML

• Host: GitHub
• URL: https://github.com/geocml/docs
• Owner: geoCML
• License: gpl-2.0
• Created: 2022-08-22T18:05:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T19:38:29.000Z (about 1 month ago)
• Last Synced: 2024-12-07T20:23:59.406Z (about 1 month ago)
• Homepage: https://geocml.github.io/docs
• Size: 788 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# geoCML documentation

This repository hosts the documentation for the geoCML project. geoCML documentation is rendered to HTML and PDF from [Asciidoc](https://asciidoc.org/) files (.adoc) using [docToolchain](http://doctoolchain.org/docToolchain/v2.0.x/index.html). _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](https://github.com/geoCML/geocml-base-deployment)) 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

Requirements:

 - asciidoctor

 - asciidoctor-pdf

 - asciidoctor-diagram

*nix / Bash:

> Run `./gradlew generateHTML generatePDF`