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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d5f351861887be69ab497eedafc1e34394ab1227168afa1a18e07338107da34 |
|
MD5 | 2cf26216213dfa7b5be3145fcb7a4777 |
|
BLAKE2b-256 | 9140f3ed63f46d7c5f7de5f987ff1459facbf0d9e370754ca85c67eb47685652 |
Close
Hashes for mkdocs_blogging_plugin-2.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 531b4992c8cd46feb9079245ef4488d8476fb4ccb900cc7bd19823a32dbe8974 |
|
MD5 | a00534182c1586d92809c14639e08cf5 |
|
BLAKE2b-256 | d056a4def7bef12ccd7b75b2d03b4aa839fe6a9cc935801dd1b89c5d09b16c37 |