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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91b3ebc1ee3870958a0f9304d985f73a8e170a1f8d17948488415fa1a4257b2e |
|
MD5 | ba2f2eb2bdc6c2ee0a1002dfa58408c8 |
|
BLAKE2b-256 | da1efb81d3ac143643c3ecf52ba7c3d1af24c5000e7ec5f43763bda7b289e378 |
Close
Hashes for mkdocs_blogging_plugin-2.2.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e0f14e5a5d9d7fa106ee014b04a49e2fdb5ffe70a0026106dceb79930ba8ac2 |
|
MD5 | 48b7876ad21a8f415666f45a5d841d7e |
|
BLAKE2b-256 | a046bbcbb8e1eb3e7f223f69c1851f1785292a5fbd51af6443ba9e00715528bf |