Improve wording of revision date plugin options

This commit is contained in:
Tim Vink 2021-04-19 11:44:26 +02:00
parent 8029b58d3d
commit f672303322

View File

@ -123,7 +123,7 @@ The following options are supported:
`enabled_if_env`{ #enabled_if_env } `enabled_if_env`{ #enabled_if_env }
: :octicons-milestone-24: Default: _none_ This option defines whether the : :octicons-milestone-24: Default: _none_ Define whether the
date is actually extracted from git, which makes it possible to disable date is actually extracted from git, which makes it possible to disable
extraction for cases when the repository is not available: extraction for cases when the repository is not available:
@ -164,7 +164,7 @@ The following options are supported:
`type`{ #type } `type`{ #type }
: :octicons-milestone-24: Default: `date` This option allows to change the : :octicons-milestone-24: Default: `date` Change the
format of the date to be displayed. Valid values are `date`, `datetime`, format of the date to be displayed. Valid values are `date`, `datetime`,
`iso_date`, `iso_datetime` and `timeago`: `iso_date`, `iso_datetime` and `timeago`:
@ -176,7 +176,7 @@ The following options are supported:
`fallback_to_build_date`{ #fallback_to_build_date } `fallback_to_build_date`{ #fallback_to_build_date }
: :octicons-milestone-24: Default: `false` This option specifies whether : :octicons-milestone-24: Default: `false` Specifies whether
the time when `mkdocs build` was executed should be used as a fallback when the time when `mkdocs build` was executed should be used as a fallback when
the git repository is not available: the git repository is not available:
@ -188,7 +188,7 @@ The following options are supported:
`enable_creation_date`{ #enable_creation_date } `enable_creation_date`{ #enable_creation_date }
: :octicons-milestone-24: Default: `false` This option specifies whether to also add a page *Created* date at the bottom of each page. : :octicons-milestone-24: Default: `false` Whether to add a *Created* date at the bottom of each page.
``` yaml ``` yaml
plugins: plugins: