MkDocs Bootstrap Theme

This project provides MkDocs themes for the different Bootstrap 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

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:

For example:

theme: cerulean

Or:

theme: yeti

As with the base mkdocs theme, you can request alternate colors for the navigation header. Allowed values are primary (the default), dark, and light:

theme:
    name: cerulean
    nav_style: dark

Screenshots

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

Cerulean

Cerulean

Cosmo

Cosmo

Cyborg

Cyborg

Darkly

Darkly

Flatly

Flatly

Journal

Journal

Litera

Litera

Lumen

Lumen

Lux

Lux

Materia

Materia

Minty

Minty

Pulse

Pulse

Sandstone

Sandstone

Simplex

Simplex

Slate

Slate

Solar

Solar

Spacelab

Spacelab

Superhero

Superhero

United

United

Yeti

Yeti

Search documentation

Enter words to search this site.