Skip to content

Commit 431129a

Browse files
small readme tweaks
1 parent dc3c5bc commit 431129a

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,9 @@
77

88
A custom MkDocs plugin designed to dynamically generate an "Authors" page for your documentation site from a simple YAML file. This allows you to easily manage and display information about contributors without manually updating Markdown files.
99

10-
The YAML format is kept consistent with Material's ["Defining authors"](https://squidfunk.github.io/mkdocs-material/tutorials/blogs/navigation/#defining-authors), which enables blog post author attribution.
11-
12-
If you wish to automatically generate authors based on a git repository, [git-authors](https://github.com/timvink/mkdocs-git-authors-plugin) is a tidy plugin to do this.
13-
14-
The `authors-plugin` is developed for instances where you want to manually define an authors list,
15-
for example for a wider project team, or non-code contributors.
10+
The YAML format is kept consistent with Material's ["Defining authors"](https://squidfunk.github.io/mkdocs-material/tutorials/blogs/navigation/#defining-authors), which enables blog post author attribution. This means that if you are
11+
creating a blog you will not have to define `.authors.yml` twice. Note that `authors` can be used
12+
independently (without a blog) as well.
1613

1714
## Features
1815

@@ -125,6 +122,13 @@ internal list of files. This tells MkDocs that there is a page called `authors.m
125122
part of the documentation build. This mean a physical file does not have to exist at
126123
`docs/authors.md`.
127124

125+
## Other plugins
126+
127+
If you wish to automatically generate authors based on a git repository, [git-authors](https://github.com/timvink/mkdocs-git-authors-plugin) is a tidy plugin to do this.
128+
129+
The `authors-plugin` is developed for instances where you want to manually define an authors list,
130+
for example for a wider project team, or non-code contributors.
131+
128132
## Contributing
129133

130134
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on the [GitHub repository](https://github.com/thomaszwagerman/mkdocs-authors-plugin).

0 commit comments

Comments
 (0)