MkDocs Bootstrap Theme#

This project provides legacy MkDocs themes based on the 1.0.x version of the mkdocs theme for the different Bootstrap 2 themes provided by the Bootswatch project.

Installation & Usage#

Install the collection of themes with pip, which is hopefully how you installed MkDocs.

pip install mkdocs-bootswatch-classic

After installation is complete, edit your mkdocs.yml config file and set the theme to one of the following Bootwatch themes included. The full list is as follows:

• mkdocs-classic
• amelia-classic
• bootstrap-classic
• cerulean-classic
• cosmo-classic
• cyborg-classic
• flatly-classic
• journal-classic
• readable-classic
• simplex-classic
• slate-classic
• spacelab-classic
• united-classic
• yeti-classic

For example:

theme: amelia-classic

Or:

theme: yeti-classic

In addition, you can request an inverted navigation header:

extra:
    theme_inverse: true

Screenshots#

This documentation is rendered with the Bootswatch Flatly theme. Previews of the other themes can be seen below.

MkDocs#

Amelia#

Bootstrap#

Cerulean#

Cosmo#

Cyborg#

Flatly#

Journal#

Readable#

Simplex#

Slate#

Spacelab#

United#

Yeti#