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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6bd65fed1728fb05521679e30fe9f91269db0cf8078235a42313cca0d4b065e9 |
|
MD5 | 34e317cbd7e835a4c24baa48f62898a0 |
|
BLAKE2b-256 | 003256ff5f90e0765dec2f792ca6ea9b67f6922b754504750214d309876e379c |
Close
Hashes for mkdocs_blogging_plugin-2.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eefca043b7f0c345bb3536a7ca0425a5b5be4e18add09586a20e91a94c18681 |
|
MD5 | 65a5b5067bec4fc390daf752ad656b4e |
|
BLAKE2b-256 | 99d80c887bb1863ae496eca114c4e6912b7e981a7b69e0a2927773459d86e748 |