Using Hugo as site generator for SeMoX Documentation

Documentation Site

Because SeMoX is very much about data concepts and specifications documentation is a our first class citizen.

We figured that Hugo is a good tool for adopting documentation as code (which some of us call “code controlled documentation”). Hence, this page describes the way we use Hugo.

We chose Docsy as main theme. Main reasons:

1. It is all about documentation
2. Supports blogging
3. Multi-Lingual

Shortcodes

We use shortcodes to have a central place for little template driven snippets.

E.g.

• pname for the project name. Here: SeMoX

Architecture Decision Records (ADR)

We also created a Front Matter based section for ADRs.

1. archetype

2. organizing content