Updated documentation and fixed syntax error in schema

This commit is contained in:
squidfunk 2022-10-01 17:08:41 +02:00
parent cec89f0c6d
commit 0a5ab025b5
3 changed files with 34 additions and 4 deletions

View File

@ -17,7 +17,7 @@
"properties": { "properties": {
"enabled": { "enabled": {
"title": "Enable plugin", "title": "Enable plugin",
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.enabled",
"type": "boolean", "type": "boolean",
"default": true "default": true
}, },
@ -26,6 +26,12 @@
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository",
"type": "string" "type": "string"
}, },
"branch": {
"title": "Repository branch",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.branch",
"type": "string",
"default": "master"
}
}, },
"additionalProperties": false, "additionalProperties": false,
"required": [ "required": [

View File

@ -180,6 +180,18 @@ plugins:
The following configuration options are supported: The following configuration options are supported:
[`enabled`](#+git-revision-date-localized.enabled){ #+git-revision-date-localized.enabled }
: :octicons-milestone-24: Default: `true` This option specifies whether
the plugin is enabled when building your project. If you want to switch
the plugin off, e.g. for local builds, use an [environment variable]:
``` yaml
plugins:
- git-revision-date-localized:
enabled: !ENV [CI, false]
```
[`type`](#+git-revision-date-localized.type){ #+git-revision-date-localized.type } [`type`](#+git-revision-date-localized.type){ #+git-revision-date-localized.type }
: :octicons-milestone-24: Default: `date` The format of the date to be : :octicons-milestone-24: Default: `date` The format of the date to be
@ -255,6 +267,18 @@ plugins:
The following configuration options are supported: The following configuration options are supported:
[`enabled`](#+git-committers.enabled){ #+git-committers.enabled }
: :octicons-milestone-24: Default: `true` This option specifies whether
the plugin is enabled when building your project. If you want to switch
the plugin off, e.g. for local builds, use an [environment variable]:
``` yaml
plugins:
- git-committers:
enabled: !ENV [CI, false]
```
[`repository`](#+git-committers.repository){ #+git-committers.repository } [`repository`](#+git-committers.repository){ #+git-committers.repository }
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ : :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__
@ -267,7 +291,7 @@ The following configuration options are supported:
repository: squidfunk/mkdocs-material repository: squidfunk/mkdocs-material
``` ```
`branch`{ #committers-repository } [`branch`](#+git-committers.branch){ #+git-committers.branch }
: :octicons-milestone-24: Default: `master` This property should be set to : :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: the branch of the repository from which to retrieve the contributors. To use the `main` branch:
@ -284,7 +308,7 @@ them at your own risk.
[Insiders]: ../insiders/index.md [Insiders]: ../insiders/index.md
[git-committers]: https://github.com/ojacques/mkdocs-git-committers-plugin-2 [git-committers]: https://github.com/ojacques/mkdocs-git-committers-plugin-2
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
[rate limits]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting [rate limits]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
#### Document authors :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" } #### Document authors :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" }

View File

@ -182,7 +182,7 @@ The following configuration options are available:
``` yaml ``` yaml
plugins: plugins:
- privacy: - privacy:
enabled: !ENV [PRIVACY, false] enabled: !ENV [CI, false]
``` ```
[`externals`](#+privacy.externals){ #+privacy.externals } [`externals`](#+privacy.externals){ #+privacy.externals }