Skip to content

MkDocs Mad Libs

PyPI - Version Contributor Covenant Documentation Status

Code templating with user inputs for PyMdown superfences; an incarnation of Mad Libs for your documentation.

Example

MkDocs Mad Libs is simple to use—templated inputs are surrounded by triple underscores.

The following markdown code:

```madlibs
python
~~~
print("Hello, ___NAME___, welcome to MkDocs Mad Libs!")
```

Turns into:

print("Hello, NAME, welcome to MkDocs Mad Libs!")

Installation

mkdocs-madlibs is distributed through PyPI, and installable via pip:

pip install mkdocs-madlibs