mkdocs-recently-updated-docs
English | 简体中文
Display a list of recently updated documents anywhere on your MkDocs site with a single line of code. The recent updates module displays site documentation information in a structured way, which is ideal for sites with a large number of documents or frequent updates, allowing readers to quickly see what's new.
Features
- Display recently updated documents in descending order by update time, list items are dynamically updated
- Support multiple view modes including list, detail and grid
- Support automatic extraction of article summaries
- Support for customizing article cover in Front Matter
- Support custom display quantity
- Support exclude specified files or folders
- 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 (support unix shell-style wildcards)
- index.md # Exclude specific file
- '*/index.md' # Exclude all index.md files in any subfolders
- blog/* # Exclude all files in blog folder, including subfolders
Usage
Simply write this line anywhere in your md document:
<!-- RECENTLY_UPDATED_DOCS -->
Configure article cover
Use the field cover in Front Matter to specify the article cover (supports URL paths and local file paths):
---
cover: assets/cat.jpg
---
Other projects
- MaterialX, the next generation of mkdocs-material. Build beautiful sites the way you already know and love. Based on
mkdocs-material-9.7.1and is namedX, it provides ongoing maintenance and updates (since mkdocs-material will stop being maintained).
Updates have been released that refactor and add a lot of new features, see https://github.com/jaywhj/mkdocs-materialx/releases/
-
mkdocs-document-dates, a new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
Chat Group
Discord: https://discord.gg/cvTfge4AUy
Wechat:
Metadata
Release files for mkdocs-recently-updated-docs 1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_recently_updated_docs-1.7.tar.gz | 7.1 kB | Without provenance | Details for mkdocs_recently_updated_docs-1.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_recently_updated_docs-1.7-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_recently_updated_docs-1.7-py3-none-any.whl |
Total release size: 15.5 kB
Release files / mkdocs_recently_updated_docs-1.7.tar.gz
| Download URL | mkdocs_recently_updated_docs-1.7.tar.gz |
|---|---|
| Size | 7.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
06b05d4e0dea0e8327998c5c8a72826d6899e932ef433957669867a8bc44f994
|
|
BLAKE2b-256 checksum How to use checksums |
6606a79e1e4cc8ff9a4b590f889babe8dc7d6f438d8cc4e40d7ab77b121e5b1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.0
|
Release files / mkdocs_recently_updated_docs-1.7-py3-none-any.whl
| Download URL | mkdocs_recently_updated_docs-1.7-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
378ff0e31cb185d7d4985a564cf10af83ae07a77136a8e1c0c76edab43175276
|
|
BLAKE2b-256 checksum How to use checksums |
8fec05fd668a92503fe59e5d9ec67c10e78a87209a24f768031f6fd2e2135dc8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.0
|
Security for mkdocs-recently-updated-docs 1.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.