slarrauri / mkdocs-blogging-plugin

A mkdocs plugin that generates a blog page listing selected pages, sorted by time.

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.