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:
- Auto-generated blog pages
- 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.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2891fd4971b042ae4589d0d1cff0d1c6daa552bab7522904f3403fc3bf4782ec |
|
MD5 | e4f7de242fcf422a2fc7ec1eb5e9b8be |
|
BLAKE2b-256 | e5b47bec585d1aefd615f81e533653522f01c4972d676daced8c7b0a5b2aee2d |
Close
Hashes for mkdocs_blogging_plugin-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce8b89963526d748f5a469746c252ee50958cc42add05900b249572f9ccd3232 |
|
MD5 | 0f18fa1645f11413c47d9542be9c6fa6 |
|
BLAKE2b-256 | 1e44e5b9a291391deb831438d83b64333be6672b593a31f885dca8a374770e8d |