Skip to content

Commit c9688c8

Browse files
fix(ci): add CNAME file to docs/ and fix mkdocs deployment (#23)
**Problem:** - GitHub Pages custom domain kept getting reset - Workflow used `mkdocs gh-deploy --custom-domain mnemex.dev` flag - This flag doesn't exist, causing deployments to fail - Failed deployments left GitHub Pages API without custom domain set **Solution:** - Add CNAME file to docs/ directory (standard mkdocs pattern) - Remove invalid `--custom-domain` flag from workflow - MkDocs automatically deploys CNAME file to gh-pages branch - GitHub Pages API setting manually configured via `gh api` command **How it works:** - CNAME file in docs/ is copied during `mkdocs gh-deploy` - Both CNAME file AND GitHub Pages API must be set - This ensures custom domain persists across deployments Fixes the recurring issue of custom domain being reset. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 0833422 commit c9688c8

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@ jobs:
4646
run: mkdocs build --strict
4747

4848
- name: Deploy to GitHub Pages
49-
# Include custom domain to preserve CNAME on each deploy
50-
run: mkdocs gh-deploy --force --custom-domain mnemex.dev
49+
# CNAME file in docs/ dir will be deployed automatically
50+
run: mkdocs gh-deploy --force

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mnemex.dev

0 commit comments

Comments
 (0)