Skip to main content

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

preview

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


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.11.tar.gz (14.3 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_blogging_plugin-2.2.11-py3-none-any.whl (18.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page