mkdocs-demo

Demo repository to setup mkdocs. This demo is based on this youtube tutorial. More information can be found in the mkdocs-material documentation.

• 1. Install
• 2. Snippets
• 3. Publishing Documentation

---

1. Install

# Install packages
poetry install

# Install pre-commit
pre-commit install

2. Snippets

# Run server to host your documentation
mkdocs serve

# Build static content
mkdocs build

3. Publishing Documentation

Documentation will be hosted via GitHub-Pages either by updating the documentation manually with:

mkdocs gh-deploy

or using the GitHub CI (Actions). The published documentation can be found here. When setting up, it might be necessary to adjust the settings for Pages to "Deploy from a branch", but that was not the case when setting up this repository.