Skip to content

Commit

Permalink
Add sentence on usage in README
Browse files Browse the repository at this point in the history
  • Loading branch information
timvink committed Sep 12, 2021
1 parent 200f31a commit 080b568
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ plugins:
> 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.

You can then use the `{{ git_page_authors }}` tag in your markdown document, or choose to customize your mkdocs theme (see [usage](https://timvink.github.io/mkdocs-git-authors-plugin/usage.html) page in the docs).

### Note when using build environments

This plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:
Expand All @@ -51,7 +53,7 @@ This plugin needs access to the last commit that touched a specific file to be a

## Documentation

See https://timvink.github.io/mkdocs-git-authors-plugin/
See [timvink.github.io/mkdocs-git-authors-plugin](https://timvink.github.io/mkdocs-git-authors-plugin/)

## Contributing

Expand Down

0 comments on commit 080b568

Please sign in to comment.