Example
Here's a printout of the plugin's config file, which I've included using a jinja-style macro.
# You can even use this with other plugins, like
# [macros](https://pypi.org/project/mkdocs-macros-plugin/) to achieve advanced
# configurations.
site_name: ok-with-macros
docs_dir: /tmp/mkdocs-simple/ok-with-macros/docs
plugins:
- search
- simple:
include_extensions:
- ".yml"
- macros:
verbose: True
extra:
test: True
And the extracted module documentation also includes the config file.
extracted:
## Python Version
You can put _markdown_ in triple-quoted strings in Python.
You can even use macros to inject other markdown here!
For example, here's the config file:
````yaml
site_name: athackst/mkdocs-simple-plugin
docs_dir: /tmp/mkdocs-simple/mkdocs-simple-plugin
plugins:
- simple:
include_extensions:
- .yml
- .png
- .pages
- .bats
- .sh
- awesome-pages
- macros
- search
edit_uri: ''
site_url: https://athackst.github.io/mkdocs-simple-plugin
repo_url: https://github.com/athackst/mkdocs-simple-plugin
theme:
name: material
palette:
primary: green
accent: green
markdown_extensions:
- admonition
- pymdownx.superfences
- pymdownx.highlight:
use_pygments: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji ''
emoji_generator: !!python/name:materialx.emoji.to_svg ''
- mkdocs-click
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/althack
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/althack
- icon: fontawesome/regular/face-laugh
link: https://allisonthackston.com
analytics:
provider: google
property: G-VPNW28KW9L
````