Improved and extended version of the Windmill theme
Project description
CustomMill theme for MkDocs
Another iteration on the awesome Windmill theme for MkDocs. This is permitted by the MIT License.
Highlights:
- Convenient navigation for larger documentation projects.
- Retains state of the navigation menu across page transitions.
- Deep nesting of documentation folders
- Search with term highlighting.
- User may search in a quick dropdown or load results in a full page.
- Default mkdocs theme within pages, including syntax highlighting.
- Custom coloring through sass
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
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
File details
Details for the file mkdocs-custommill-1.2.2.tar.gz.
File metadata
- Download URL: mkdocs-custommill-1.2.2.tar.gz
- Upload date:
- Size: 1.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a8ec2a70eb8d4486076f65c4ebb1f9c566c9f37c097591a48d9e7dce8643e8bb |
|
| MD5 | fb0e6b7bc3392f937bdb98c5081408dc |
|
| BLAKE2b-256 | 6957d55191493f8df821f5dd471d28061d6abd2ad9d10f9af69e20bdfb7d7f4a |
File details
Details for the file mkdocs_custommill-1.2.2-py3-none-any.whl.
File metadata
- Download URL: mkdocs_custommill-1.2.2-py3-none-any.whl
- Upload date:
- Size: 2.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b842d3af3a865ee04ec3b1340268f8475f64a717e6a63216683a91389647dfc1 |
|
| MD5 | 7e0e218a7d2cb99937d8eb6a14e339ef |
|
| BLAKE2b-256 | d1b2e759afce49b132656127702480920720a94dc585cc18405408f8a79082fd |
