Skip to content

Commit 9c0d2c8

Browse files
authored
docs: deploy to gh-pages on push to main (#538)
2 parents 3b01b3c + 22756b5 commit 9c0d2c8

File tree

5 files changed

+34
-4
lines changed

5 files changed

+34
-4
lines changed

.github/workflows/mkdocs.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: Publish docs
22
on:
3+
push:
4+
branches:
5+
- main
36
pull_request:
47
branches:
58
- main
@@ -73,3 +76,26 @@ jobs:
7376
repo: context.repo.repo,
7477
body: `Preview url: https://${hostnamePrefix}-${{ github.event.number }}--${hostnameSuffix}`,
7578
})
79+
80+
docs-publish:
81+
runs-on: ubuntu-latest
82+
# don't publish for pull requests
83+
if: github.event.pull_request == null
84+
steps:
85+
- name: Checkout
86+
uses: actions/checkout@v6
87+
88+
- uses: actions/setup-python@v6
89+
with:
90+
python-version-file: .github/workflows/.python-version
91+
cache: pip
92+
cache-dependency-path: |
93+
"docs/requirements.txt"
94+
95+
- name: Install MkDocs requirements
96+
run: |
97+
pip install -r docs/requirements.txt
98+
99+
- name: Deploy MkDocs website
100+
run: |
101+
mkdocs gh-deploy --force

docs/explanation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Hello explanation
1+
# Coming soon

docs/guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Hello guides
1+
# Coming soon

docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
# Hello docs!
1+
# Digital Service Design Language
2+
3+
Cal-ITP's Digital Service Design Language (DSDL) is a (work in progress) attempt to unify design elements across various products.
4+
5+
You'll be able to learn more about it here very soon.

docs/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Hello reference
1+
# Coming soon

0 commit comments

Comments
 (0)