Skip to main content

A MkDocs plugin to show recently updated documents

Project description

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

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.2.tar.gz (4.7 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for mkdocs_recently_updated_docs-1.2.tar.gz
Algorithm Hash digest
SHA256 34157ae8aab0bf7c9ac7b7b085096f7e37aa1e6c6b0a23ecc526484c747fe032
MD5 e706ba81dc98a0e66feb5a2bfe2ea9d9
BLAKE2b-256 46f5eeace34eb50b3e10a9d71ae5b5c24305c077eb4f03362c2653cead7f2b7b

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