@@ -180,6 +180,18 @@ plugins:
180
180
181
181
The following configuration options are supported :
182
182
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
+
183
195
[`type`](#+git-revision-date-localized.type){ # +git-revision-date-localized.type }
184
196
185
197
: :octicons-milestone-24 : Default: `date` – The format of the date to be
@@ -255,6 +267,18 @@ plugins:
255
267
256
268
The following configuration options are supported:
257
269
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
+
258
282
[ ` repository ` ] ( #+git-committers.repository ) { #+git-committers.repository }
259
283
260
284
: :octicons-milestone-24: Default: _ none_ · :octicons-alert-24: __ Required__ –
@@ -267,7 +291,7 @@ The following configuration options are supported:
267
291
repository: squidfunk/mkdocs-material
268
292
```
269
293
270
- ` branch ` { #committers-repository }
294
+ [ ` branch ` ] ( #+git-committers.branch ) { #+git-committers.branch }
271
295
272
296
: :octicons-milestone-24: Default: ` master ` – This property should be set to
273
297
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.
284
308
285
309
[ Insiders ] : ../insiders/index.md
286
310
[ 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
288
312
[ rate limits ] : https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
289
313
290
314
#### Document authors :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" }
0 commit comments