CustomMill theme for MkDocs
Another iteration on the awesome Windmill theme for MkDocs. This is permitted by the MIT License.
Highlights:
- Clean navigation for large documentation projects
- Retains the state of the menu across page transitions
- Versatile search with term highlighting in a quick search and on its own page
- Supports syntax highlighting within pages
- Deep nesting of pages in folders
Improvements over Windmill
- Customizable colors!
- Customizable links in the navigation menu
- A lot of small stylistic and design fixes
- Better search result listing
- Bootstrap 5 and no more jQuery
Quick start
To install using pip:
pip install mkdocs-custommill
To use in mkdocs.yml:
theme: custommill
Demo and documentation
See here for a demo and some documentation :)
Development
If doing development on mkdocs-custommill, check it out with
git clone https://github.com/Siphalor/mkdocs-custommill/
cd mkdocs-custommill
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-custommill 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-custommill-1.3.0.tar.gz | 1.5 MB | Without provenance | Details for mkdocs-custommill-1.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_custommill-1.3.0-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_custommill-1.3.0-py3-none-any.whl |
Total release size: 4.1 MB
Release files / mkdocs-custommill-1.3.0.tar.gz
| Download URL | mkdocs-custommill-1.3.0.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4af3b0544ca15b3cffae8333057008ddee447ac5236de46fd89926c4a8005ab1
|
|
BLAKE2b-256 checksum How to use checksums |
4ccabddac4c0cf0217e503f4d59ebfc86ff7f32ab7e716a78a47e3ec690b4ec8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10
|
Release files / mkdocs_custommill-1.3.0-py3-none-any.whl
| Download URL | mkdocs_custommill-1.3.0-py3-none-any.whl |
|---|---|
| Size | 2.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a99781f03fd62ffd4c956ad5af49b6bdc92d30762f389b0455e79d554124e273
|
|
BLAKE2b-256 checksum How to use checksums |
4ab1b1debd5f2fa35a98d48e328867e3d44945021158917e7915e1a79c72d023
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10
|
Security for mkdocs-custommill 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
