https://github.com/liang2kl/mkdocs-blogging-plugin

Add blogging feature to your MkDocs site.
https://github.com/liang2kl/mkdocs-blogging-plugin

blog mkdocs mkdocs-plugin

Last synced: 5 days ago
JSON representation

Add blogging feature to your MkDocs site.

• Host: GitHub
• URL: https://github.com/liang2kl/mkdocs-blogging-plugin
• Owner: liang2kl
• License: mit
• Created: 2021-09-07T08:53:20.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-21T03:54:31.000Z (over 1 year ago)
• Last Synced: 2024-12-08T19:53:18.635Z (14 days ago)
• Topics: blog, mkdocs, mkdocs-plugin
• Language: Python
• Homepage: https://liang2kl.github.io/mkdocs-blogging-plugin
• Size: 414 KB
• Stars: 84
• Watchers: 3
• Forks: 17
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://s2.loli.net/2021/12/03/GqhwCYTsimlkXK1.png)

## 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

```shell

# 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](https://github.com/liang2kl/mkdocs-blogging-plugin-bootstrap).

## Credits

Inspired by [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material-blog](https://github.com/vuquangtrong/mkdocs-material-blog).