Add recent updates module¶

10.0.4 document-dates

You can add a list of recently updated documents anywhere in your document 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 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

Installation¶

This feature is provided by the plugin document-dates, which should be installed first:

pip install mkdocs-document-dates

then configure the switch recently-updated in mkdocs.yml:

- document-dates:
    ...
    recently-updated:
      limit: 10         # Limit the number of docs displayed
      exclude:          # Exclude documents you don't want to show
        - index.md          # Example: exclude the specified file
        - '*/index.md'      # Example: exclude all index.md files in any subfolders
        - blog/*            # Example: exclude all files in blog folder, including subfolders

You can also install the plugin mkdocs-recently-updated-docs to use alone

Configuration¶

The following configuration options are supported:

limit: 10 This option specifies the number of documents to be displayed.
exclude: This option specifies a list of documents to be excluded, supporting unix shell-style wildcards, such as *, ?, [] etc.

Download the sample template nav.html, and override this path docs/overrides/partials/nav.html

Add anywhere in document¶

Insert this line anywhere in your document:

<!-- RECENTLY_UPDATED_DOCS -->

Configure article cover¶

Use the field cover in Front Matter to specify the article cover, which supports URL paths and local file paths, for example:

---
cover: assets/cat.jpg
---