Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2025-01-18 08:54:46 +01:00
Code Issues Releases Wiki Activity

Update getting started guide for the requirement for "Improved Container Support" (#2195)

Browse Source
This commit is contained in:
David Young 2021-01-09 23:18:54 +13:00 committed by GitHub
parent c07172804a
commit e193d2f721
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/getting-started.md
View File

@ -50,6 +50,7 @@ _environment variable to the token's value._
and usage of an access token is only necessary when installing Insiders and usage of an access token is only necessary when installing Insiders
over HTTPS, which is the recommended way when building from within a CI/CD over HTTPS, which is the recommended way when building from within a CI/CD
workflow, e.g. using [GitHub Pages][16] or [GitLab Pages][17]. workflow, e.g. using [GitHub Pages][16] or [GitLab Pages][17].
[5]: https://python-markdown.github.io/ [5]: https://python-markdown.github.io/
[6]: https://pygments.org/ [6]: https://pygments.org/
@ -94,7 +95,8 @@ _environment variable to the token's value._
[GitHub Container Registry][18], the [personal access token][14] requires [GitHub Container Registry][18], the [personal access token][14] requires
the [`read:packages`][15] scope. Note that you need to login before pulling the [`read:packages`][15] scope. Note that you need to login before pulling
the Docker image. As an example, see the [`publish`][19] workflow of the the Docker image. As an example, see the [`publish`][19] workflow of the
Material for MkDocs repository. Material for MkDocs repository. You'll also need to enable "[Improved Container Support][20]"
on your account.
[10]: https://hub.docker.com/r/squidfunk/mkdocs-material/ [10]: https://hub.docker.com/r/squidfunk/mkdocs-material/
[11]: https://github.com/byrnereese/mkdocs-minify-plugin [11]: https://github.com/byrnereese/mkdocs-minify-plugin
@ -156,3 +158,4 @@ sponsor][9]._
[17]: publishing-your-site.md#gitlab-pages [17]: publishing-your-site.md#gitlab-pages
[18]: https://docs.github.com/en/free-pro-team@latest/packages/getting-started-with-github-container-registry/about-github-container-registry [18]: https://docs.github.com/en/free-pro-team@latest/packages/getting-started-with-github-container-registry/about-github-container-registry
[19]: https://github.com/squidfunk/mkdocs-material/blob/master/.github/workflows/publish.yml [19]: https://github.com/squidfunk/mkdocs-material/blob/master/.github/workflows/publish.yml
[20]: https://docs.github.com/en/free-pro-team@latest/packages/guides/enabling-improved-container-support