The documentation source is stored in Git. This works, but when consulting the documentation on other devices I will have to constantly pull and push from the git repository. This is not ideal. A better solution would be to have the pipeline convert the markdown files to HTML files and serve these HTML files directly instead. We can use static website generators for that.
You can find a lot of these via Jamstack.
Jekyl
Jekyl is a Ruby based library to create static websites.
Quartz
Quartz is a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites. It is written in. It requires Node.js to run. We’ve got a whole page dedicated how to set this up.
MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. We are already using this for jetspotter.
Docusaurus
Docusaurus is running on Node.js and also looks nice.