A vanilla Bootstrap 4 theme
Project description
Bootstrap 4 theme for MkDocs
A vanilla Bootstrap 4 theme.
Screenshot
Quick start
First install the package:
$ pip install mkdocs-theme-bootstrap4
Then enable it:
theme:
name: bootstrap4
Configuration
Place these additional options under the theme:
section of your mkdocs.yml
configuration to change the theme's behaviour.
# Show next/previous links between pages?
next_previous: true
Hacking
To get completion working in your editor, set up a virtual environment in the root of this repository and install MkDocs:
$ pip3 install --user --upgrade setuptools twine wheel
$ python3 -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txt
To install the plugin onto a local MkDocs site in editable form:
$ pip install --editable /path/to/mkdocs-theme-bootstrap4
Releasing
Build the distributable package:
$ python3 setup.py sdist bdist_wheel
Push it to the PyPI test instance:
$ python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Test it inside a virtual environment:
$ pip install --index-url https://test.pypi.org/simple/ --no-deps mkdocs-drawio-exporter
Let's go live:
$ python3 -m twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs-theme-bootstrap4-0.2.0.tar.gz
(768.4 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-theme-bootstrap4-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa79ef9f28139a33569c848840aa58a810e88d32091acf7ee668dc2042b34003 |
|
MD5 | 0fdac97d8daa3306fada9e2dc6124402 |
|
BLAKE2b-256 | 394351ecf38ed8ed07843c5a21362deda8a2355ad7b0321ac1a3d0bf1bd2e152 |
Close
Hashes for mkdocs_theme_bootstrap4-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da16e7606d0d9ba07e7b7de5cb62a79a25b85693cfd1854127555540a36e1858 |
|
MD5 | ef06df4412460f7b5d6a971f5020eef1 |
|
BLAKE2b-256 | ef5e7d7cb547b53b909dd119d762bd99153fbf88acf711de07a5c9d22679081d |