Skip to content

Commit

Permalink
Further improve wording of revision date plugin options
Browse files Browse the repository at this point in the history
  • Loading branch information
timvink committed Apr 22, 2021
1 parent f672303 commit 33212c5
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/setup/adding-a-git-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ The following options are supported:

`enabled_if_env`{ #enabled_if_env }

: :octicons-milestone-24: Default: _none_ – Define whether the
date is actually extracted from git, which makes it possible to disable
: :octicons-milestone-24: Default: _none_ – When specified the data will only be extracted from git
if the environment variable exists. This makes it possible to disable
extraction for cases when the repository is not available:

``` yaml
Expand Down Expand Up @@ -164,9 +164,8 @@ The following options are supported:

`type`{ #type }

: :octicons-milestone-24: Default: `date` – Change the
format of the date to be displayed. Valid values are `date`, `datetime`,
`iso_date`, `iso_datetime` and `timeago`:
: :octicons-milestone-24: Default: `date` – The format of the date to be displayed.
Valid values are `date`, `datetime`, `iso_date`, `iso_datetime` and `timeago`:

``` yaml
plugins:
Expand All @@ -176,8 +175,8 @@ The following options are supported:

`fallback_to_build_date`{ #fallback_to_build_date }

: :octicons-milestone-24: Default: `false` – Specifies whether
the time when `mkdocs build` was executed should be used as a fallback when
: :octicons-milestone-24: Default: `false` – Enables falling back to
the time when `mkdocs build` was executed. Can be used as a fallback when
the git repository is not available:

``` yaml
Expand All @@ -188,7 +187,7 @@ The following options are supported:

`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
plugins:
Expand Down

0 comments on commit 33212c5

Please sign in to comment.