Skip to content

Commit

Permalink
Automatically show 'last update' date (#1743)
Browse files Browse the repository at this point in the history
* add feature to show date of last update

* added installation instructions for mkdocs-git-revision-date-localized-plugin
  • Loading branch information
eldonquijote authored Feb 4, 2021
1 parent 22da3e8 commit 58ba18c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ branches:
install:
- pip install mkdocs
- pip install mkdocs-material
- pip install mkdocs-git-revision-date-localized-plugin

script:
- mkdocs build --clean
Expand Down
8 changes: 6 additions & 2 deletions docs/technical-documentation/docs-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,17 @@ This documentation is built using [mkdocs](http://www.mkdocs.org/), a static sit

## Prerequisites

You will need to have `mkdocs` installed locally, as well as the mkdocs theme.
You will need to have `mkdocs` installed locally, as well as a required plugin and the MkDocs _Material_ theme.

Install `mkdocs`:

`sudo -H pip install mkdocs`

Install material theme:
Install plugin to enable display of the last revision date:

`sudo -H pip install mkdocs-git-revision-date-localized-plugin`

Install Material theme:

`sudo -H pip install mkdocs-material`

Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ markdown_extensions:
permalink: True
extra_css:
- css/custom.css
plugins:
- search
- git-revision-date-localized

extra:
font:
Expand Down

0 comments on commit 58ba18c

Please sign in to comment.