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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b6060d318419359c04550a4deac07de8cf3ef98003192f89e110927b3673a8d |
|
MD5 | 3db6d0720f055a6f1a279435c73198cd |
|
BLAKE2b-256 | 4a543bc33adfc335cf9fc64b672b6b4f2480d31e8a82d4b20bc14e50cc44ebc1 |
Close
Hashes for mkdocs_blogging_plugin-2.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc43e4270ba73f96770fbb5c0e0ea6368b59f488ad37737ec2b51b18b16b9901 |
|
MD5 | bf2fc075d889019298c5592104cfd08c |
|
BLAKE2b-256 | a821ce56088e1f2ddff1d5df6613306b4de94c3bd348e04b6110f8aceb0831dc |