/MKDocs-Inspired

Mkdocs mobile responsive theme with slider navigation inspired by bootswatch flatly

Primary LanguageHTMLMIT LicenseMIT

MkDocs "Inspired" Theme

Mkdocs-Inspired is an additioal theme for Mkdocs based on bootswatch-flatly, and features a mobile friendly responsive slider (drawer) navivation menu.

Dependency

Mkdocs-Inspired requires python, and the Mkdocs project in order to work correctly.

Before installing MKDocs-Inspired you need to install the following dependencies:

Installation

You can easily download the Mkdocs-Inspired theme with Pip:

pip install mkdocs-inspired

Use it by configuring your mkdocs.yml file

theme: inspired

Then run it like other mkdocs themes by following below command:

mkdocs serve

For more information about Mkdocs-inspired, checkout the project on Github