Mkdocs plugin that generates a blog index page sorted by creation date.
Project description
mkdocs-blogging-plugin
A mkdocs plugin that generates a blog page listing selected pages, sorted by time. It supports:
- Automatic blog page generation
- Tags
- Category-level customization
- Template-based customization
Demo site: https://liang2kl.github.io/mkdocs-blogging-plugin-example
Prerequisites
- Only
material
theme is adapted by far navigation.instant
feature cannot be enabled if blog paging is on
Pull requests are welcome to break these constraints.
Installation
# macOS or Linux
pip3 install mkdocs-blogging-plugin
# Windows
pip install mkdocs-blogging-plugin
Usage
A complete guide is available at https://liang2kl.github.io/mkdocs-blogging-plugin.
You might need to follow the migration guide to upgrade to a new version.
Credits
Inspired by mkdocs-git-revision-date-localized-plugin and mkdocs-material-blog.
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
Close
Hashes for mkdocs-blogging-plugin-2.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a53c3e84cf28cc0e4331a438c406031d75b9fdd275eb7ec56b58865acdab2ee4 |
|
MD5 | e9516bf16827c554e7d1045ac4849a58 |
|
BLAKE2b-256 | 8a979cf3249bef251efa30e018f94f05a64205eb1781afaf503059874b8eaacf |
Close
Hashes for mkdocs_blogging_plugin-2.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 292d5a993f46cc008d68e23d4594d3a84cc80c84f47a5a0ae623d2e960cf02b6 |
|
MD5 | 9eb3f80a9c1b5151992cb94c84ab9e21 |
|
BLAKE2b-256 | 73ca4c1c895c68d3424351f7d14c46eb07070ecd00917830471068b079c0b937 |