build: Use git-committers plugin #256
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rather than using git-authors (whose rendering functionality is now natively included in mkdocs-material, and which always wants to display a mailto: link containing authors' email addresses), use the git-committers plugin which instead links to contributors' GitHub accounts. Since this relies on GitHub API calls that are rate-limited and potentially quite time-consuming during a local build, enable the plugin only when running from GitHub Actions workflows.
|
We'll go with #257 instead (which we will update and merge once mkdocs-material 9.5.3 is out). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rather than using
git-authors(whose rendering functionality is now natively included in mkdocs-material, and which always wants to display amailto:link containing authors' email addresses), use thegit-committersplugin which instead links to contributors' GitHub accounts.Since this relies on GitHub API calls that are rate-limited and potentially quite time-consuming during a local build, enable the
plugin only when running from GitHub Actions workflows.