Glossary
- Admonition
- A styled call-out block used for notes, tips, warnings, and other highlighted information.
- Diátaxis
- A documentation framework that organises content into tutorials, how-to guides, reference, and explanations.
- GitHub Actions
- GitHub's automation service for running workflows such as building and deploying documentation.
- GitHub Pages
- A static hosting service for publishing a website directly from a GitHub repository.
- Markdown
- A lightweight markup language used to write readable plain-text documentation.
- Markdown extension
- An add-on that expands Markdown with extra features such as admonitions, tabs, or diagrams.
- MkDocs
- A static site generator for project documentation, written in Python.
- Material for MkDocs
- A theme for MkDocs that provides a modern look and many features such as search, navigation, and extensions.
- Mermaid
- A diagram written in Mermaid syntax and rendered from text, useful for flowcharts, sequence diagrams, and more.
- Python-Markdown
- The Markdown parser used by MkDocs to convert Markdown content into HTML.
- Static site generator
- A tool that builds a website (HTML, CSS, JavaScript, etc.) from source files such as Markdown and configuration data.