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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92377b622413bffd0594d9bad64d72f575c80daf5acfd97966e9770c8351b6c9 |
|
MD5 | 432ee7b53eb2ff9c041105f5f522deac |
|
BLAKE2b-256 | 58b7c9a04522005de5f0f2f45e88cef16c71f391e66f7ae568fb0211d4f71903 |
Close
Hashes for mkdocs_blogging_plugin-2.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe62dee2e460bda0528aafc1fa65d757c3a6799aed4d7aea76ac44f73db8ddc2 |
|
MD5 | ec7a5ed495f4df5890bdf8cc2ec699bb |
|
BLAKE2b-256 | e5ff8f33e5acd9647f4ad5a7819a6a7152b08033e4092cc97bc2ca6901c1390b |