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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c847749d82896b033c7e562e7e6a2add1e2c3ac43c87908ff18fe527a900eff4 |
|
MD5 | a328c29f92a97c2f299c3fe7f6c26e10 |
|
BLAKE2b-256 | 85b2e1dfc4600c5bf0d1b401219c115887d6b2bd83825c76fcc79c0a2136a95c |
Close
Hashes for mkdocs_blogging_plugin-2.2.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ba0c0bfc7ba3800176956d877feb93887585bf601c7506cd25333bd942ca1bd |
|
MD5 | 2628087d62752cac107ed4e074cbe57e |
|
BLAKE2b-256 | a4dd244139791143575af5b6b2008364f5955ef160236bd4fff5143c70e1aa50 |