https://github.com/waylan/mkdocs-nature

A MkDocs theme.
https://github.com/waylan/mkdocs-nature

documentation mkdocs mkdocs-theme theme

Last synced: 25 days ago
JSON representation

A MkDocs theme.

• Host: GitHub
• URL: https://github.com/waylan/mkdocs-nature
• Owner: waylan
• License: other
• Created: 2017-03-13T02:45:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-09-14T18:55:28.000Z (over 1 year ago)
• Last Synced: 2024-12-07T22:50:23.114Z (about 1 month ago)
• Topics: documentation, mkdocs, mkdocs-theme, theme
• Language: CSS
• Homepage: https://waylan.github.io/mkdocs-nature/
• Size: 806 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
=============

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/