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
mkdocs-blogging-plugin-2.1.tar.gz
(13.9 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-blogging-plugin-2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55d337c9dadcd0b13592f0516b0cadef0b8f3434482b0abd93bcc313ddb79313 |
|
MD5 | 09f86c465542fbf0a82557ec091ae6db |
|
BLAKE2b-256 | d4a17f5091a1c525e39be8046c14fba2e2b2db13b5c0fd4bf032a50c0d990d2e |
Close
Hashes for mkdocs_blogging_plugin-2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | feb290edc3f2591f14d0423549ddf2d87b5d8409458f07e8996c90fd11d9af72 |
|
MD5 | 05ffa887d11838848c6404a73c22c723 |
|
BLAKE2b-256 | b73ab51eb5e8416ca26092632f3b7cfb8415e52e5126639c71dec1046d81632d |