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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aad0a6678ed7a5ed4d3b7c49cbb11127567d352d6dc86234b1a56e9fdf8f322d |
|
MD5 | 53ddc9a270d7fba583c4de6954cdd11e |
|
BLAKE2b-256 | 8a8cf7f2658add8903a5e5676f36aaed9f3f1028c62cccb7a9c6500d826a3f55 |
Close
Hashes for mkdocs_blogging_plugin-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6b440cca9e3393b7d415b5a9dc41bd1fad9faa82126aff5b5f414c31c34baa6 |
|
MD5 | a408a9e216afc69776708220ca4ad5b3 |
|
BLAKE2b-256 | df2b53abddd11f8b85fe9ddc7aad759b4d75ef453db2fc65ec993cd827a4f583 |