Skip to main content

A MkDocs plugin to show recently updated documents

Project description

mkdocs-recently-updated-docs

English | 简体中文

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

Features

  • Support list display of recently updated documents
  • 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

recently-updated

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
        - drafts/*       # Exclude all files in drafts 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 time, last update time, authors, email of documents

render

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_recently_updated_docs-1.1.tar.gz (4.6 kB view details)

Uploaded Source

File details

Details for the file mkdocs_recently_updated_docs-1.1.tar.gz.

File metadata

File hashes

Hashes for mkdocs_recently_updated_docs-1.1.tar.gz
Algorithm Hash digest
SHA256 4eafe6b87979265294f403c967db536ec7417af944725ca887b8937b1d87560a
MD5 c4d962a11749b5a9747e24934346172d
BLAKE2b-256 e007fb0de305e95e5bd255b4ec7a67b8ba0bf6ede6c7b3d0dc25aa097361ce64

See more details on using hashes here.

Supported by

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