Skip to content

Commit 0a5ab02

Browse files
committed
Updated documentation and fixed syntax error in schema
1 parent cec89f0 commit 0a5ab02

File tree

3 files changed

+34
-4
lines changed

3 files changed

+34
-4
lines changed

docs/schema/plugins/external/git-committers.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"properties": {
1818
"enabled": {
1919
"title": "Enable plugin",
20-
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
20+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.enabled",
2121
"type": "boolean",
2222
"default": true
2323
},
@@ -26,6 +26,12 @@
2626
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository",
2727
"type": "string"
2828
},
29+
"branch": {
30+
"title": "Repository branch",
31+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.branch",
32+
"type": "string",
33+
"default": "master"
34+
}
2935
},
3036
"additionalProperties": false,
3137
"required": [

docs/setup/adding-a-git-repository.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,18 @@ plugins:
180180

181181
The following configuration options are supported:
182182

183+
[`enabled`](#+git-revision-date-localized.enabled){ #+git-revision-date-localized.enabled }
184+
185+
: :octicons-milestone-24: Default: `true` – This option specifies whether
186+
the plugin is enabled when building your project. If you want to switch
187+
the plugin off, e.g. for local builds, use an [environment variable]:
188+
189+
``` yaml
190+
plugins:
191+
- git-revision-date-localized:
192+
enabled: !ENV [CI, false]
193+
```
194+
183195
[`type`](#+git-revision-date-localized.type){ #+git-revision-date-localized.type }
184196

185197
: :octicons-milestone-24: Default: `date` – The format of the date to be
@@ -255,6 +267,18 @@ plugins:
255267

256268
The following configuration options are supported:
257269

270+
[`enabled`](#+git-committers.enabled){ #+git-committers.enabled }
271+
272+
: :octicons-milestone-24: Default: `true` – This option specifies whether
273+
the plugin is enabled when building your project. If you want to switch
274+
the plugin off, e.g. for local builds, use an [environment variable]:
275+
276+
``` yaml
277+
plugins:
278+
- git-committers:
279+
enabled: !ENV [CI, false]
280+
```
281+
258282
[`repository`](#+git-committers.repository){ #+git-committers.repository }
259283

260284
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__
@@ -267,7 +291,7 @@ The following configuration options are supported:
267291
repository: squidfunk/mkdocs-material
268292
```
269293

270-
`branch`{ #committers-repository }
294+
[`branch`](#+git-committers.branch){ #+git-committers.branch }
271295

272296
: :octicons-milestone-24: Default: `master` – This property should be set to
273297
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.
284308

285309
[Insiders]: ../insiders/index.md
286310
[git-committers]: https://github.com/ojacques/mkdocs-git-committers-plugin-2
287-
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
311+
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
288312
[rate limits]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
289313

290314
#### Document authors :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" }

docs/setup/ensuring-data-privacy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ The following configuration options are available:
182182
``` yaml
183183
plugins:
184184
- privacy:
185-
enabled: !ENV [PRIVACY, false]
185+
enabled: !ENV [CI, false]
186186
```
187187

188188
[`externals`](#+privacy.externals){ #+privacy.externals }

0 commit comments

Comments
 (0)