Skip to content

Commit ebf0287

Browse files
committed
Added a note in GitHub Actions
1 parent 3547155 commit ebf0287

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

.github/workflows/documentation.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ jobs:
6767
env:
6868
GH_TOKEN: ${{ secrets.GH_TOKEN }}
6969
run: |
70+
# Warning: please don't use this method when installing Insiders from
71+
# CI! We have to do it this way in order to allow for overrides on our
72+
# own documentation, but you should stick to the method we recommend
73+
# in the publishing guide – see https://bit.ly/3zjdJtw
7074
git clone --depth 1 https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
7175
pip install -e mkdocs-material-insiders
7276
cp mkdocs-material-insiders/mkdocs.yml mkdocs.yml

0 commit comments

Comments
 (0)