mkdocs-recently-updated-docs

English | 简体中文

One line of code to display a list of recently updated documents

Features

• Supports display of recently updated documents in an overall list
• Flexible display position (sidebar or in md document)
• Rich template examples
• Works well for any environment (no-Git, Git, 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, personalize the configuration:

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

Usage

Just write this line in your md document anywhere:

<!-- RECENTLY_UPDATED_DOCS -->

Custom template

See templates directory

Other plugins

mkdocs-document-dates

A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents