You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,9 @@
7
7
8
8
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.
9
9
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.
16
13
17
14
## Features
18
15
@@ -125,6 +122,13 @@ internal list of files. This tells MkDocs that there is a page called `authors.m
125
122
part of the documentation build. This mean a physical file does not have to exist at
126
123
`docs/authors.md`.
127
124
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
+
128
132
## Contributing
129
133
130
134
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