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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 322546bc540bb5caace47dec352f6cf680020f5bb03ef105dc494c008ca107f5 |
|
MD5 | b3fcb89a9069f62854f9fe2ee4627f9b |
|
BLAKE2b-256 | 678498e0c44e669de54a206c20e0b0a90f091a4166b4e68c92d36893352fe675 |
Close
Hashes for mkdocs_blogging_plugin-2.2.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 248f0b6d8ad0efa106b0216b1e5f4bffa59ab3f08b3fc9c3c1137ce1a2112e21 |
|
MD5 | e141bfe7cae14c15512b584994a5cfa4 |
|
BLAKE2b-256 | 3d51673c2b29814c8fd131d5fa0805b5e4c3b9927ed9ec06f07d145108bcfbbb |