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
First, install the dependencies:
- Python 2, for some of our dependencies.
- Python 3, for the package build process.
- Yarn, for managing frontend dependencies.
Ensure that Python 2 is found on your path before Python 3, else you'll get errors from node-gyp
later. If you're unable to do this, set the environment variable npm_config_python
to a command that'll launch Python 2 (py -2
on Windows, python2
elsewhere).
On Windows:
- It's easiest to not put Python on your path and instead rely on the
py
CLI. - You'll need the build tools necessary to install native dependencies:
npm install -g --production windows-build-tools
.
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
Built Distribution
Hashes for mkdocs-theme-bootstrap4-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 390eb64a31f33289634d3f1d208f975e86576ed273f9d0cbcb962795551a69dc |
|
MD5 | 20b5efb18d4a950cb84ab10412f45d50 |
|
BLAKE2b-256 | 3b268af66ce527e967cdecc18ba746802ae0cc960f863e5a334952b09cd0414d |
Hashes for mkdocs_theme_bootstrap4-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26e25479d2eadd41364e56ca8f428c23266480890302bbb814294a908fe726b0 |
|
MD5 | 8afd9dc6bbe25ad8a4a31595deaf64b5 |
|
BLAKE2b-256 | 93bc6f309e4aceb3426d0f58238b5c3dd06ef6246d3ad23c52251e5d5d205757 |