diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index f426aca1a..5ff93142d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -57,7 +57,7 @@ jobs: run: | pip install . pip install \ - "mkdocs-git-committers-plugin-2>=0.4.3" \ + "mkdocs-git-committers-plugin-2>=1.0.0" \ "mkdocs-git-revision-date-localized-plugin>=1.0" \ "mkdocs-minify-plugin>=0.3" \ "mkdocs-redirects>=1.0" diff --git a/docs/schema/plugins/external/git-committers.json b/docs/schema/plugins/external/git-committers.json index c6c43f0ab..018075312 100644 --- a/docs/schema/plugins/external/git-committers.json +++ b/docs/schema/plugins/external/git-committers.json @@ -26,11 +26,6 @@ "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config", "type": "string" }, - "token": { - "title": "Personal access token", - "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config", - "type": "string" - } }, "additionalProperties": false, "required": [ diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 6da55fd13..064ce3e1e 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -233,7 +233,7 @@ Then, add the following lines to `mkdocs.yml`: plugins: - git-committers: repository: squidfunk/mkdocs-material - token: !ENV GH_TOKEN + branch: main ``` The following configuration options are supported: @@ -250,21 +250,15 @@ The following configuration options are supported: repository: squidfunk/mkdocs-material ``` -`token`{ #committers-repository } +`branch`{ #committers-repository } -: :octicons-milestone-24: Default: _none_ – This property should[^3] be set to - a [personal access token], which is used by the plugin to query GitHub's API - for document contributor information: - - [^3]: - Setting a [personal access token] is not required, but recommended, as - GitHub has very low [rate limits] on their APIs that you'll probably run - into. When using a token, [rate limits] are much higher. +: :octicons-milestone-24: Default: `master` – This property should be set to + the branch of the repository from which to retrieve the contributors. To use the `main` branch: ``` yaml plugins: - git-committers: - token: !ENV GH_TOKEN + branch: main ``` The other configuration options of this extension are not officially supported