Skip to content

Commit fb3f880

Browse files
committed
Documentation
1 parent 8169e7f commit fb3f880

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

docs/publishing-your-site.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ contents:
4444
- run: mkdocs gh-deploy --force
4545
```
4646

47-
1. You can change the name to your liking.
47+
1. You can change the name to your liking.
4848

49-
2. At some point, GitHub renamed `master` to `main`. If your default branch
50-
is named `master`, you can safely remove `main`, vice versa.
49+
2. At some point, GitHub renamed `master` to `main`. If your default branch
50+
is named `master`, you can safely remove `main`, vice versa.
5151

52-
3. This is the place to install further [MkDocs plugins] or Markdown
53-
extensions with `pip` to be used during the build:
52+
3. This is the place to install further [MkDocs plugins] or Markdown
53+
extensions with `pip` to be used during the build:
5454

5555
``` sh
5656
pip install \
@@ -137,30 +137,27 @@ contents:
137137
- public
138138
```
139139

140-
1. At some point, GitLab renamed `master` to `main`. If your default branch
141-
is named `master`, you can safely remove `main`, vice versa.
140+
1. At some point, GitLab renamed `master` to `main`. If your default branch
141+
is named `master`, you can safely remove `main`, vice versa.
142142

143143
=== "Insiders"
144144

145145
``` yaml
146146
image: python:latest
147147
pages:
148148
stage: deploy
149-
only: # (1)!
149+
only:
150150
- master
151151
- main
152-
script: # (2)!
152+
script: # (1)!
153153
- pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
154154
- mkdocs build --site-dir public
155155
artifacts:
156156
paths:
157157
- public
158158
```
159159

160-
1. At some point, GitLab renamed `master` to `main`. If your default branch
161-
is named `master`, you can safely remove `main`, vice versa.
162-
163-
2. Remember to set the `GH_TOKEN` environment variable to the value of your
160+
1. Remember to set the `GH_TOKEN` environment variable to the value of your
164161
[personal access token] when deploying [Insiders], which can be done
165162
using [masked custom variables].
166163

0 commit comments

Comments
 (0)