https://github.com/byrnereese/mkdocs-bootstrap4

Bootstrap 4.0+ theme for MkDocs
https://github.com/byrnereese/mkdocs-bootstrap4

Last synced: 3 days ago
JSON representation

Bootstrap 4.0+ theme for MkDocs

• Host: GitHub
• URL: https://github.com/byrnereese/mkdocs-bootstrap4
• Owner: byrnereese
• License: mit
• Created: 2018-12-17T16:32:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-11-05T01:03:43.000Z (about 4 years ago)
• Last Synced: 2024-11-03T22:33:16.144Z (5 days ago)
• Language: HTML
• Size: 448 KB
• Stars: 46
• Watchers: 5
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - byrnereese/mkdocs-bootstrap4 - Bootstrap 4.0+ theme for MkDocs (HTML)
• awesome-starred - byrnereese/mkdocs-bootstrap4 - Bootstrap 4.0+ theme for MkDocs (others)

README

        
# 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](https://github.com/byrnereese/mkdocs-git-committers-plugin) for MkDocs. Consult that plugin's documentation for proper configuration. 

## Screenshot




## See Also

[MkDocs]: https://www.mkdocs.org

[mkdocs.yml]: https://www.mkdocs.org/user-guide/configuration/

[name]: https://www.mkdocs.org/user-guide/configuration/#name