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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e30a7739a0668efae534f56cd6a8ef7e6d97fcad505550aecf9b1d5d2a2392d2 |
|
MD5 | 1877e18aed82a97b09cf86291f7831f2 |
|
BLAKE2b-256 | 891b55b440ef84fb771c21f579fe8632b65d4bb8a231f66eccd2ed8db5ae7eb0 |
Close
Hashes for mkdocs_blogging_plugin-2.2.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc11dfac3d73456c4f8ef9d497110cddf1e7d678ecb7b0f0343140cd9d3cba75 |
|
MD5 | f9e73763f0a63abf64a78ae9a1a91c82 |
|
BLAKE2b-256 | 485844407801cdf598f6765e02bce1d1317f3b5ff0048219c0aa9feee74ae089 |