Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-18 18:36:07 +01:00
Code Issues Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2024-12-05 17:13:20 +01:00
parent eab6959d0c
commit 6c796c06ec
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/insiders/getting-started.md
View File

@ -83,10 +83,10 @@ comfortable self-hosting:
5. [Create a new release] to build and publish the Docker image 5. [Create a new release] to build and publish the Docker image
6. Install [Pull App] on your fork to stay in-sync with upstream 6. Install [Pull App] on your fork to stay in-sync with upstream
The [`publish`][publish] workflow[^5] is automatically run when a new tag The [`build`][build] workflow is automatically run when a new tag
(release) is created. When a new Insiders version is released on the upstream (release) is created. When a new Insiders version is released on the upstream
repository, the [Pull App] will create a pull request with the changes and repository, the [Pull App] will create a pull request with the changes and
pull in the new tag, which is picked up by the [`publish`][publish] workflow pull in the new tag, which is picked up by the [`build`][build] workflow
that builds and publishes the Docker image automatically to your private that builds and publishes the Docker image automatically to your private
registry. registry.
@ -116,12 +116,6 @@ outlined in the [Getting Started guide](../getting-started.md#with-docker).
token created to access the Insiders repository, it's safer to create a token created to access the Insiders repository, it's safer to create a
dedicated token which you'll only use for publishing the Docker image. dedicated token which you'll only use for publishing the Docker image.
[^5]:
The Insiders repository contains two GitHub Actions workflows:
- `build.yml` – Build and lint the project (disabled on forks)
- `publish.yml` – Build and publish the Docker image
### with git ### with git
Of course, you can use Material for MkDocs Insiders directly from `git`: Of course, you can use Material for MkDocs Insiders directly from `git`:
@ -145,7 +139,7 @@ pip install -e mkdocs-material
[GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository [GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
[Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release [Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release
[Pull App]: https://github.com/apps/pull [Pull App]: https://github.com/apps/pull
[publish]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/publish.yml [build]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/build.yml
## Built-in plugins ## Built-in plugins