Skip to content

Commit 4f2e550

Browse files
committed
build: deploy docs from Cloudflare Pages
1 parent a2fc1ab commit 4f2e550

7 files changed

Lines changed: 27 additions & 17 deletions

File tree

.github/workflows/documentation.yml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,21 @@ on:
66
- 'master'
77
paths:
88
- 'docs/**'
9+
- '.github/workflows/documentation.yml'
10+
- 'wrangler.jsonc'
911

1012
jobs:
11-
deploy:
13+
build:
1214
runs-on: ubuntu-latest
1315
steps:
14-
- uses: actions/checkout@v2
15-
- uses: actions/setup-python@v2
16+
- uses: actions/checkout@v4
17+
18+
- uses: actions/setup-python@v5
1619
with:
1720
python-version: 3.x
18-
- run: |
19-
cd docs
20-
pip install mkdocs-material
21-
mkdocs gh-deploy --force
21+
22+
- name: Install documentation dependencies
23+
run: python -m pip install -r docs/requirements.txt
24+
25+
- name: Build documentation
26+
run: npm run docs:build

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,7 @@ data.json
2121
# Exclude macOS Finder (System Explorer) View States
2222
.DS_Store
2323

24-
__snapshots__
24+
__snapshots__
25+
26+
# Documentation build output
27+
docs/site

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
mkdocs==1.6.1
2+
mkdocs-material==9.7.6

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
"authorUrl": "https://bagerbach.com",
99
"fundingUrl": "https://buymeacoffee.com/chhoumann",
1010
"isDesktopOnly": false
11-
}
11+
}

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
"version": "node version-bump.mjs && git add manifest.json versions.json",
1313
"semantic-release": "semantic-release",
1414
"test": "npm run check:a11y && vitest",
15-
"check:a11y": "svelte-check --fail-on-warnings"
15+
"check:a11y": "svelte-check --fail-on-warnings",
16+
"docs:build": "mkdocs build -f docs/mkdocs.yml -d site",
17+
"docs:deploy": "npm run docs:build && npx wrangler pages deploy docs/site --project-name podnotes --branch master"
1618
},
1719
"keywords": [],
1820
"author": "Christian Bager Bach Houmann",

vercel.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

wrangler.jsonc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "podnotes",
3+
"compatibility_date": "2026-04-30",
4+
"pages_build_output_dir": "./docs/site"
5+
}

0 commit comments

Comments
 (0)