MkDocs Examples and Tests

An example site to test out various MkDocs features, mostly with the Material theme.

Each test or demo is on its own branch.

mkdocs-macros-plugin

Branch: yaml-plugin-demo

mkdocs-macros-plugin allows you to use variables and macros in your MkDocs sites. It's a powerful tool, and I recommend reading the mkdocs-macros documentation to learn more about it.

This branch focuses on one task: using YAML to define variables that you can then use in your site. This can range from pulling in something from your mkdocs.yml and displaying it in your content, to using extra YAML files to generate page contents.

Run the examples

You need:

• Python 3.7 or above.
• git

git clone https://github.com/StarfallProjects/mkdocs-macros-yaml-examples.git
cd mkdocs-examples-tests
# Create a virtual environment https://docs.python.org/3/library/venv.html
python -m venv venv
# Active your virtual environment
./venv/Scripts/<script-for-your-system>
# Check out the branch
git checkout yaml-plugin-demo
# Install requirements
pip install -r requirements.txt
# Build and serve locally
mkdocs serve