https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin

MkDocs plugin for setting revision date from git per markdown file
https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin

Last synced: 3 days ago
JSON representation

MkDocs plugin for setting revision date from git per markdown file

• Host: GitHub
• URL: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin
• Owner: zhaoterryy
• License: mit
• Created: 2018-12-03T04:29:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-28T19:19:30.000Z (almost 2 years ago)
• Last Synced: 2024-12-26T17:06:54.945Z (10 days ago)
• Language: Python
• Size: 18.6 KB
• Stars: 57
• Watchers: 5
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-git-revision-date-plugin

MkDocs plugin that displays the last revision date of the current page of the documentation based on Git. The revision date will be displayed in ISO format *(YYYY-mm-dd)*. If you need other date formats check out [timvink's fork][mkdocs-git-revision-date-localized-plugin]

## Setup

Install the plugin using pip:

`pip install mkdocs-git-revision-date-plugin`

Activate the plugin in `mkdocs.yml`:

```yaml

plugins:

  - search

  - git-revision-date

```

> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.

More information about plugins in the [MkDocs documentation][mkdocs-plugins].

## Usage

### Templates - `page.meta.revision_date`:

#### Example

```django hljs

{% block footer %}



{% if config.copyright %}

{{ config.copyright }}


{% endif %}

Documentation built with MkDocs.

{% if page.meta.revision_date %}


Updated {{ page.meta.revision_date }}

{% endif %}



{% endblock %}

```

More information about templates [here][mkdocs-template].


More information about blocks [here][mkdocs-block].

### Markdown - `{{ git_revision_date }}`:

#### Example

```md

Page last revised on: {{ git_revision_date }}

```

If using [mkdocs_macro_plugin][mkdocs-macro], it must be included after our plugin.

i.e., mkdocs.yml:

```yaml

plugins:

  - search

  - git-revision-date

  - macros

```

[mkdocs-plugins]: https://www.mkdocs.org/user-guide/plugins/

[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables

[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks

[mkdocs-macro]: https://github.com/fralau/mkdocs_macros_plugin

[mkdocs-git-revision-date-localized-plugin]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin

## Options

### `enabled_if_env`

Setting this option will enable the build only if there is an environment variable set to 1. Default is not set.

### `modify_md`

Setting this option to false will disable the use of `{{ git_revision_date }}` in markdown files. Default is true.

### `as_datetime`

Setting this option to True will output git_revision_date as a python `datetime`. This means you can use jinja2 date formatting, for example as `{{ git_revision_date.strftime('%d %B %Y') }}`. Default is false.