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
!ENVto 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-localizedandgit-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.xmlfor 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
timeagoandtooltip - 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.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/
Chat Group
Discord: https://discord.gg/cvTfge4AUy
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-document-dates 3.8.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mkdocs_document_dates-3.8.8.tar.gz | 196.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_document_dates-3.8.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 397.0 kB
Release files / mkdocs_document_dates-3.8.8.tar.gz
| Download URL | mkdocs_document_dates-3.8.8.tar.gz |
|---|---|
| Size | 196.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c063726a63d9b28a095a720c90ae785b41a2bf6a193b9933ae472589ca639ca1
|
|
BLAKE2b-256 checksum How to use checksums |
74138b7e6d4899ed9ebe60170bae7ffb641d844249f853f455b148adcf8626a0
|
| 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.8-py3-none-any.whl
| Download URL | mkdocs_document_dates-3.8.8-py3-none-any.whl |
|---|---|
| Size | 200.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6fe8102574088b3f0e7159e56d9bf4b8bd84be2cea9203c0c1550d9705b08c84
|
|
BLAKE2b-256 checksum How to use checksums |
74a777f412704bc8b87adaade05c2594cda78e1fa05c2b4913165c2430163297
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.0
|
Security for mkdocs-document-dates 3.8.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
