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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 297cae8ff7baae4b9cdcef3a2a6317a5954664c5d67223b5104a9e7bfa78eb50 |
|
MD5 | 4fabbfb9a06d7b54cfd0ec90e6796182 |
|
BLAKE2b-256 | 823904699a4e5d9440a5992c876bfedcceee30417aab9b71d4d0c81a5c3c0419 |
Close
Hashes for mkdocs_blogging_plugin-2.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75638b791556cf399f1ba19e158e32034555a880f747d315421b6d018942ae10 |
|
MD5 | 615bc1e12b5fc9f4771e8a1354c7e955 |
|
BLAKE2b-256 | 406457dafb3a14e5b9a9731d680d90151e5fe08647af8ef9db2e9592b912c5f5 |