Overview
- Authors:
- Created:
04/01/2020
- Modified:
09/19/2025
This documentation site and corresponding Git repository is meant to help document and explain the documentation system and methodology I use both personally and professionally.
The key features and benefits that it needed to possess are as follows:
Be portable and not locked in to one software or company - ideally text based
Able to be version controlled - ideally using Git
Have the ability to produce different outputs from the same content. Examples:
HTML
PDFs
ePubs
XML
etc
Handle diagrams, workflows and directed graphs that are text based
Embed YouTube, code snippets, configuration and other snippets