mkdocs-document-dates

English | 简体中文

A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents

Features

• Works in any environment: no-Git, Git environments, Docker, all CI/CD build systems, etc.
• Support list display of recently updated documents (in descending order of update date)
• Support for manually specifying date and author in Front Matter
• Support for multiple date formats (date, datetime, timeago)
• Support for multiple author modes (avatar, text, hidden)
• Support for manually configuring author's name, link, avatar, email, etc.
• Flexible display position (top or bottom)
• Elegant styling (fully customizable)
• Multi-language support, localization support, intelligent recognition of user language, automatic adaptation
• Ultimate build efficiency: O(1), no need to set the env var !ENV to distinguish runs

Build Speed Comparison:	100 md:	1000 md:	Time Complexity:
git-revision-date-localized git-authors	＞ 3 s	＞ 30 s	O(n)
document-dates	< 0.1 s	< 0.15 s	O(1)

It's 20-500 times faster than git-revision-date-localized and git-authors

Installation

pip install mkdocs-document-dates

Configuration

Just add the plugin to your mkdocs.yml:

plugins:
- document-dates

Or, common configuration:

plugins:
- document-dates:
position: top # Display position: top(after title) bottom(end of document), default: toptype: date # Date type: date datetime timeago, default: dateexclude: # List of excluded files (support unix shell-style wildcards)
- temp.md # Example: exclude the specified file
- blog/* # Example: exclude all files in blog folder, including subfolders
- '*/index.md'# Example: exclude all index.md files in any subfolders

Customization Settings

In addition to the above basic configuration, the plug-in also provides a wealth of customization options to meet a variety of individual needs:

• Date & Time: Introduces the mechanism for obtaining document dates and methods for personalized customization, support for manually specifying the creation date and last updated date for each document
• Author: Introduces the mechanism for obtaining document authors and methods for personalized customization, support for manually specifying the author information for each document, such as name, link, avatar, email, etc.
• Avatar: You can manually specify the avatar for each author, support local file path and URL path
• Structure and Style: You can freely configure the plugin's display structure in mkdocs.yml or Front Matter. You can quickly set the plugin styles through preset entrances, such as icons, themes, colors, fonts, animations, dividing line and so on
• Template Variables: Can be used to optimize sitemap.xml for site SEO
• Recently Updated Module: Enable list of recently updated documents (in descending order of update date), this is ideal for sites with a large number of documents, so that readers can quickly see what's new
• Localization Language: More localization languages for timeago and tooltip
• Developer API: Provides a date data API for developers, making it easy to retrieve exact dates in other plugins or hooks

See the documentation for details: https://jaywhj.netlify.app/document-dates-en

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.1 and is named X, 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/

Chat Group

Discord: https://discord.gg/cvTfge4AUy