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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 015a418e55f78bda18dd510ab77115674c1dd138e020fee1193f210e7dbc7366 |
|
MD5 | b90970ffd63b0cd7549ed0cbb25b4d5f |
|
BLAKE2b-256 | 7c56243c7b56ee99e161f42550839e784d9ab0d1590166b3730878235769b60c |
Close
Hashes for mkdocs_blogging_plugin-2.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 122b66707417b6b625c4ac827101688bdd4fe386b2dc84951fdd5cb656d7a450 |
|
MD5 | cbaeb864c328be5f62f6860bfd892606 |
|
BLAKE2b-256 | fc208d8c4f175b0fc5cc95aca6cbdd1717b9455108d1065d7be467c290bbb43d |