Skip to content

waylan/mkdocs-nature

Repository files navigation

MkDocs-Nature

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.