-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Closed as not planned
Labels
out of scopeIssue requests something out of scopeIssue requests something out of scope
Description
Context
Idea background:
- Sometimes, I want to use mkdocs to generate a static website in a git-less environment, and also support displaying the creation time and author of the document (mkdocs generates static web pages that don't depend on git to run, and i can upload the html directly to the server for publishing)
- Sometimes, I want to specify the author and creation date of a document
- Sometimes, I want to display the document creation date and author below the title instead of at the end of the document
- I don't want to configure too much git account info, git repo info, etc. I want to keep it simple, not too complicated.
- ...
None of the existing configurations and integrated plug-ins can satisfy all of the above, so I recommend mkdocs-document-dates.
Description
May I ask, is it possible to integrate the plugin mkdocs-document-dates into mkdocs-material?
As an addition to displaying document dates and authors.
Related links
Use Cases
I understand that similar plugins has been integrated before, but I still recommend it for several reasons:
- Adaptable to any environment, no special configuration required. For example, it is suitable for Git-free environments, CI/CD environments, multi-person collaboration scenarios, and cross-platform Mac/Linux/Windows
- Displays all the date and author info of a document at once, lightweight without any dependencies, easy to use
- Support for manually specifying time and author info in
Front Matter
- Supports Tooltip Hover Tips
- Flexible display position (top or bottom)
- Material style styling (fully customizable)
- ...
You can download and try it out first, the plugin homepage has a detailed description of the features, take a look at the basics of it, then discuss the possibility of being integrated
Visuals
Before submitting
- I have read and followed the change request guidelines.
- I have verified that my idea is a change request and not a bug report.
- I have ensured that, to the best of my knowledge, my idea will benefit the entire community.
- I have included relevant links to the documentation, related issues, and discussions to underline the need for my idea.
Metadata
Metadata
Assignees
Labels
out of scopeIssue requests something out of scopeIssue requests something out of scope