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:
- Auto-generated blog pages
- 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.
You might need to follow the migration guide to upgrade to a new version.
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
mkdocs-blogging-plugin-2.2.tar.gz
(13.8 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs-blogging-plugin-2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcfa6a03e98b1c88413a8d7fae7aa7b5f2154783a918f9dbe7274d34c76bcf91 |
|
MD5 | 498e432c8ff6c78ddafc12144eecf16c |
|
BLAKE2b-256 | 4a8bd33a07299f2cac9e61f87ac177fbf4e10a8a1a97dee1fde45e6bc0102703 |
Close
Hashes for mkdocs_blogging_plugin-2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0218db5da81e823c419cab38815890664bd1327577faf15920c9ac0585fc6af5 |
|
MD5 | 19d5082789dbe07a26aa36e7621967bc |
|
BLAKE2b-256 | 8a1a6e8ef5d365000531260f39d8c5f79cf6e414f2a907e1db32dd789794ad99 |