=============
MkDocs-Nature
.. default-role:: code
A MkDocs
_ theme. A clone of the "greenish" Sphinx theme of the same name.
For a demonstration of its features
_ see the documentation
_.
Installation
To install the MkDocs-Nature them, run the following command::
pip install mkdocs-nature
Setup
Configure your MkDocs project to use the theme by setting the theme.name
to nature
::
theme:
name: nature
For a list of supported variables which can be set in the config, see the
documented features
_.
.. _MkDocs: https://www.mkdocs.org/
.. _features: https://waylan.github.io/mkdocs-nature/features/
.. _documentation: https://waylan.github.io/mkdocs-nature/