ntno/mkdocs-macros-playground

mkdocs macro playground with docker support

MakefileUnlicense

mkdocs-macros-playground

This is a sample repo with a minimal example of the behavior I desire and describe in fralau/mkdocs_macros_plugin#75.

ntno fork reqs

docker
make
docker image with buildenv, python, mkdocs installed (see ntno/ubuntu-build-base)

ntno fork example use case

generate an environment variable file
1. manually create file (see env/ for examples)
2. OR use buildenv and a custom variables.yml file
```
make docker
make exec-build-env env=dev region=us-east-1 file="env/dev-us-east-1.env"
exit
```

add variables to mkdocs.yml in the extra section

extra:
    YOUR_VAR: !ENV [YOUR_ENV, 'some default value']

reference variables in the theme:
```
{{ config.extra.YOUR_VAR }}
```
reference variables in the docs:
```
{{ YOU_VAR }}
```
load the environment variables and run mkdocs in the same shell session
1. manually source / run (assuming you have mkdocs and pip requirements installed already)
```
source "env/dev-us-east-1.env" && \
mkdocs serve
```
2. loading handled via docker-compose argument in example Makefile
```
make serve file="env/dev-us-east-1.env"
```

references