From bd7d0db75a6065005b72e6ec31b45dfcb6f569fc Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 2 Apr 2022 15:10:50 +0200 Subject: [PATCH] Documentation --- docs/publishing-your-site.md | 6 +++--- docs/setup/adding-a-git-repository.md | 10 ++++++++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index 83c1c4c07..faeec48ae 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -91,9 +91,9 @@ Now, when a new commit is pushed to either the `master` or `main` branches, the static site is automatically built and deployed. Push your changes to see the workflow in action. -If the GitHub Page doesn't show up after a few minutes, go to your -settings of your repository and ensure that the [publishing source branch] -for your GitHub Page is set to `gh-pages`. +If the GitHub Page doesn't show up after a few minutes, go to the settings of +your repository and ensure that the [publishing source branch] for your GitHub +Page is set to `gh-pages`. Your documentation should shortly appear at `.github.io/`. diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index f9cc5e93d..dd8cc4a13 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -29,8 +29,18 @@ screens and as part of the main navigation drawer on smaller screen sizes. Additionally, for public repositories hosted on [GitHub] or [GitLab], the number of stars and forks is automatically requested and rendered. +GitHub repositories also include the tag of the latest release.[^1] + + [^1]: + Unfortunately, GitHub only provides an API endpoint to obtain the [latest + release] - not the latest tag. Thus, make sure to [create a release] (not + pre-release) for the latest tag you want to show up next to the number of + stars and forks. + [repo_url support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0 [repo_url]: https://www.mkdocs.org/user-guide/configuration/#repo_url + [latest release]: https://docs.github.com/en/rest/reference/releases#get-the-latest-release + [create a release]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release ### Repository name