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
- Supports display of recently updated documents in an overall list
- Flexible display position (
sidebarorin 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
A new generation MkDocs plugin for displaying exact creation time, last update time, authors, email of documents
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mkdocs_recently_updated_docs-0.1.tar.gz.
File metadata
- Download URL: mkdocs_recently_updated_docs-0.1.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d84d0932e5c32e3ed0a2d6a0cc73689129c258a9f53c609615bcc36a6fa48769
|
|
| MD5 |
6e8ce3eeedebb9bbffc1d6bb30981f44
|
|
| BLAKE2b-256 |
6a63a36abca9faa2b07589617acc09ad0773b550e0b0b426f5d6a8bf38dad4b1
|