Further improve wording of revision date plugin options

This commit is contained in:
Tim Vink 2021-04-22 10:56:20 +02:00
parent f672303322
commit 33212c592b

View File

@ -123,8 +123,8 @@ The following options are supported:
`enabled_if_env`{ #enabled_if_env } `enabled_if_env`{ #enabled_if_env }
: :octicons-milestone-24: Default: _none_ Define whether the : :octicons-milestone-24: Default: _none_ When specified the data will only be extracted from git
date is actually extracted from git, which makes it possible to disable if the environment variable exists. This makes it possible to disable
extraction for cases when the repository is not available: extraction for cases when the repository is not available:
``` yaml ``` yaml
@ -164,9 +164,8 @@ The following options are supported:
`type`{ #type } `type`{ #type }
: :octicons-milestone-24: Default: `date` Change the : :octicons-milestone-24: Default: `date` The format of the date to be displayed.
format of the date to be displayed. Valid values are `date`, `datetime`, Valid values are `date`, `datetime`, `iso_date`, `iso_datetime` and `timeago`:
`iso_date`, `iso_datetime` and `timeago`:
``` yaml ``` yaml
plugins: plugins:
@ -176,8 +175,8 @@ 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` Specifies whether : :octicons-milestone-24: Default: `false` Enables falling back to
the time when `mkdocs build` was executed should be used as a fallback when the time when `mkdocs build` was executed. Can be used as a fallback when
the git repository is not available: the git repository is not available:
``` yaml ``` yaml
@ -188,7 +187,7 @@ The following options are supported:
`enable_creation_date`{ #enable_creation_date } `enable_creation_date`{ #enable_creation_date }
: :octicons-milestone-24: Default: `false` Whether to add a *Created* date at the bottom of each page. : :octicons-milestone-24: Default: `false` Enables adding a *Created* date at the bottom of each page.
``` yaml ``` yaml
plugins: plugins: