Skip to content

byrnereese/mkdocs-bootstrap4

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs Bootstrap4 Theme

This project provides a Bootstrap v4.0+ theme is for the MkDocs project.

Installation

Install the theme with pip:

pip install mkdocs-bootstrap4

After the theme is installed, edit your mkdocs.yml file and set the theme name to bootstrap4:

theme:
    name: bootstrap4

Config Parameters

  • suppress_nextprev - (default: true) Toggles the display of the common "Next" and "Prev" page links in the header.

Special Features

This theme makes use of the git-committers plugin for MkDocs. Consult that plugin's documentation for proper configuration.

Screenshot

Screenshot of Bootstrap4 theme for MkDocs

See Also