Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

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

License

Notifications You must be signed in to change notification settings

octadocs/mkdocs-blogging-plugin

 
 

Repository files navigation

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

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.

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.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 58.5%
  • HTML 35.7%
  • JavaScript 5.8%