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 2021-12-27 13:50:27 +01:00
parent 8169e7f7c8
commit fb3f8806dd
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,13 +44,13 @@ contents:
- run: mkdocs gh-deploy --force - run: mkdocs gh-deploy --force
``` ```
1. You can change the name to your liking. 1. You can change the name to your liking.
2. At some point, GitHub renamed `master` to `main`. If your default branch 2. At some point, GitHub renamed `master` to `main`. If your default branch
is named `master`, you can safely remove `main`, vice versa. is named `master`, you can safely remove `main`, vice versa.
3. This is the place to install further [MkDocs plugins] or Markdown 3. This is the place to install further [MkDocs plugins] or Markdown
extensions with `pip` to be used during the build: extensions with `pip` to be used during the build:
``` sh ``` sh
pip install \ pip install \
@ -137,8 +137,8 @@ contents:
- public - public
``` ```
1. At some point, GitLab renamed `master` to `main`. If your default branch 1. At some point, GitLab renamed `master` to `main`. If your default branch
is named `master`, you can safely remove `main`, vice versa. is named `master`, you can safely remove `main`, vice versa.
=== "Insiders" === "Insiders"
@ -146,10 +146,10 @@ contents:
image: python:latest image: python:latest
pages: pages:
stage: deploy stage: deploy
only: # (1)! only:
- master - master
- main - main
script: # (2)! script: # (1)!
- pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git - pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
- mkdocs build --site-dir public - mkdocs build --site-dir public
artifacts: artifacts:
@ -157,10 +157,7 @@ contents:
- public - public
``` ```
1. At some point, GitLab renamed `master` to `main`. If your default branch 1. Remember to set the `GH_TOKEN` environment variable to the value of your
is named `master`, you can safely remove `main`, vice versa.
2. Remember to set the `GH_TOKEN` environment variable to the value of your
[personal access token] when deploying [Insiders], which can be done [personal access token] when deploying [Insiders], which can be done
using [masked custom variables]. using [masked custom variables].