Skip to main content

mkdocs-document-dates

English | 简体中文


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

render

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: top
      type: date               # Date type: date datetime timeago, default: date
      exclude:                 # 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

recently-updated

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

Metadata

Release files for mkdocs-document-dates 3.8.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-document-dates 3.8.7
File Size Uploaded
mkdocs_document_dates-3.8.7.tar.gz 195.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-document-dates 3.8.7
File Interpreter ABI Platform
mkdocs_document_dates-3.8.7-py3-none-any.whl Python 3 none any Details

Total release size: 395.7 kB

Release files / mkdocs_document_dates-3.8.7.tar.gz

Download URL mkdocs_document_dates-3.8.7.tar.gz
Size 195.2 kB
Tags Source
SHA-256 checksum
How to use checksums
da03b4fcc5f94689a92791e96ff4b38cb967b6abce8a3a465fee849451aa5f1f
BLAKE2b-256 checksum
How to use checksums
479dc77aedfdc4228b6aeb80d3ccc4d3c6e642b064f44e1ce47cef93101ff59d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.0

Release files / mkdocs_document_dates-3.8.7-py3-none-any.whl

Download URL mkdocs_document_dates-3.8.7-py3-none-any.whl
Size 200.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9f9f699ad08080e1e8b5199820350d43e8c358c1de53bb6ef386bb360316eb9f
BLAKE2b-256 checksum
How to use checksums
f4107bd3e3a5edeb1dde352b5183a05819f8d2003958f17af42fade886cb025d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.0

Release history Release notifications | RSS feed

This release

3.8.7 This release

2 release files

3.8.6

2 release files

3.8.5

2 release files

3.8.2

2 release files

3.8.0

2 release files

3.7.4

2 release files

3.7.3

2 release files

3.7.2

2 release files

3.7.1

2 release files

3.7.0

2 release files

3.6.1

1 release file

3.6.0

1 release file

3.5.2

1 release file

3.5.1

1 release file

3.5

1 release file

3.4.9

1 release file

3.4.7

1 release file

3.4.6

1 release file

3.4.5

1 release file

3.4.1

1 release file

3.4

1 release file

3.3.5

1 release file

3.3.4

1 release file

3.3.3

1 release file

3.3.1

1 release file

3.3

1 release file

3.2.1

1 release file

3.2

1 release file

3.1.6

1 release file

3.1.5

1 release file

3.1.3

1 release file

3.1.2

1 release file

3.1.1

1 release file

3.1

1 release file

3.0.1

1 release file

3.0.0

1 release file

2.4.0

1 release file

2.3.3

1 release file

2.3.2

1 release file

2.3.1

1 release file

2.3.0

1 release file

2.2.0

1 release file

2.1.0

1 release file

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page