OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2022-04-02 15:10:50 +02:00
parent 3adf71550c
commit bd7d0db75a
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/publishing-your-site.md
View File

@ -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 static site is automatically built and deployed. Push your changes to see
the workflow in action. the workflow in action.
If the GitHub Page doesn't show up after a few minutes, go to your If the GitHub Page doesn't show up after a few minutes, go to the settings of
settings of your repository and ensure that the [publishing source branch] your repository and ensure that the [publishing source branch] for your GitHub
for your GitHub Page is set to `gh-pages`. Page is set to `gh-pages`.
Your documentation should shortly appear at `<username>.github.io/<repository>`. Your documentation should shortly appear at `<username>.github.io/<repository>`.

10
docs/setup/adding-a-git-repository.md
View File

@ -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 Additionally, for public repositories hosted on [GitHub] or [GitLab], the
number of stars and forks is automatically requested and rendered. 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 support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
[repo_url]: https://www.mkdocs.org/user-guide/configuration/#repo_url [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 ### Repository name