Building the Documentation
How to develop and build the documentation.
Documenting Stroom
This section covers the development and maintenance of this documentation site. The documentation for Stroom is a community effort with contributions from developers and users.
This site is built using Hugo with the Docsy Hugo theme. The content is pre-dominantly authored in Markdown with some Hugo shortcodes.
Useful external links
- Hugo static site generator.
- Docsy theme for Hugo.
- Commonmark Markdown cheat sheet and tutorial.
Managing Stroom Versions
How to manage documentation for different versions of Stroom.
Documentation Style Guide
A guide on the house style, structure and content for this site. It should be viewed both in its rendered form and as source to understand how the page elements are formed. You should read this section before contributing to the documentation.
Last modified May 3, 2024: Add docs on internal links. (8fbdbc8)