Skip to content

Commit 080b568

Browse files
committed
Add sentence on usage in README
1 parent 200f31a commit 080b568

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ plugins:
3737
3838
> 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.
3939

40+
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).
41+
4042
### Note when using build environments
4143

4244
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:
@@ -51,7 +53,7 @@ This plugin needs access to the last commit that touched a specific file to be a
5153

5254
## Documentation
5355

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

5658
## Contributing
5759

0 commit comments

Comments
 (0)