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.
The easiest way to setup everything from scratch is generating your project from the template repository.
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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba4718a4dad49e093e1e1e7a7bd05cd91e6dc9429c27dd6081f9a290a865bc5b |
|
MD5 | a68a731be0a2b133846de204776f0cac |
|
BLAKE2b-256 | 1c55a46e20a6e1718be306f75168af4b0223c659316414cdf37bc61c01a0bd41 |
Close
Hashes for mkdocs_blogging_plugin-2.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cd8fce95ef912dd9aebf32304a07ce116adcc69b13ae412252a31f3b462c8c2 |
|
MD5 | b320802b2a2da647ad4ef80e50187bbf |
|
BLAKE2b-256 | 555e16550529cd5ec0c3a216302caa785ee328d0d11c3080bf136535cd2dd1d5 |