mkdocs-recently-updated-docs 1.3

A MkDocs plugin to show recently updated documents

mkdocs-recently-updated-docs

English | 简体中文

Display a list of recently updated documents anywhere on your MkDocs site with a single line of code. This is ideal for sites with a large number of documents, so that readers can quickly see what's new.

Features

• Display recently updated documents in descending order of update time
• Support exclude specified files or folders
• Support custom display quantity
• Support custom rendering template
• Works well for any environment (no-Git, Git, Docker, all CI/CD build systems, etc.)

Preview

Installation

pip install mkdocs-recently-updated-docs

Configuration

Just add the plugin to your mkdocs.yml:

plugins:
  - recently-updated

Or, full configuration:

plugins:
  - recently-updated:
      limit: 10          # Limit the number of docs displayed
      exclude:           # List of excluded files
        - index.md       # Exclude specific file
        - blog/*         # Exclude all files in blog folder, including subfolders
      template: templates/recently_updated_list.html    # Custom rendering template

Usage

Simply write this line anywhere in your md document:

<!-- RECENTLY_UPDATED_DOCS -->

Custom template

See templates directory

Other plugins

mkdocs-document-dates

A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents