mkdocs-blogging-plugin 1.1.0

Mkdocs plugin that generates a blog index page sorted by creation date.

mkdocs-blogging-plugin

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

• Automatically generates a blog index page
• Can be grouped by tags
• Support deep customization without dirty work

Prerequisites

• Only material theme is adapted by far
• navigation.instant feature cannot be enabled if blog paging is on
• Windows is not supported currently

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.