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.
- 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.)
pip install mkdocs-recently-updated-docsJust add the plugin to your mkdocs.yml:
plugins:
- recently-updatedOr, 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 subfoldersSimply write this line anywhere in your md document:
<!-- RECENTLY_UPDATED_DOCS -->Use the field cover in Front Matter to specify the article cover (supports URL paths and local file paths):
---
cover: assets/cat.jpg
---- 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
Discord: https://discord.gg/cvTfge4AUy
Wechat:
