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.

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
        - blog/*
      # template: templates/recently_updated_list.html

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 the documents to be excluded.

template

This option specifies the path to the custom rendering template.

Add to sidebar navigation

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

Add anywhere in the document

Insert this line anywhere in your document:

<!-- RECENTLY_UPDATED_DOCS -->

Custom template

See templates directory