Documentation

This commit is contained in:
squidfunk 2021-11-13 12:13:45 +01:00
parent 76035dee40
commit 53aece0bf3
2 changed files with 5 additions and 4 deletions

View File

@ -17,7 +17,7 @@ that new features are first exclusively released to sponsors as part of
</div> </div>
<figcaption markdown> <figcaption markdown>
The official documentation is built with Insiders This documentation is built with Insiders
[squidfunk.github.io/mkdocs-material][Material for MkDocs] [squidfunk.github.io/mkdocs-material][Material for MkDocs]
</figcaption> </figcaption>

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, ensure the source branch If the GitHub Page doesn't show up after a few minutes, go to your
for your GitHub Page is set to `gh-pages` in your repository settings settings of your repository and ensure that the [publishing source branch]
`github.com/<username>/<repository>/settings/pages`. for your GitHub 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>`.
@ -102,6 +102,7 @@ Your documentation should shortly appear at `<username>.github.io/<repository>`.
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token [personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[Insiders]: insiders/index.md [Insiders]: insiders/index.md
[GitHub secrets]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets [GitHub secrets]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
[publishing source branch]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
### with MkDocs ### with MkDocs