Skip to content

fix: switch GitHub Pages from broken MkDocs to Fumadocs static export#205

Closed
tuandinh0801 wants to merge 1 commit intochopratejas:mainfrom
tuandinh0801:main
Closed

fix: switch GitHub Pages from broken MkDocs to Fumadocs static export#205
tuandinh0801 wants to merge 1 commit intochopratejas:mainfrom
tuandinh0801:main

Conversation

@tuandinh0801
Copy link
Copy Markdown
Contributor

Summary

  • GitHub Pages docs site has been serving empty/404 pages since commit 911eb85 (Apr 12) which moved all MkDocs .md files to wiki/ and replaced them with Fumadocs .mdx files, but never updated the CI workflow or created the missing docs/lib/ source files.
  • Switch docs.yml workflow from MkDocs (mkdocs gh-deploy) to Next.js static export (next buildactions/deploy-pages)
  • Add output: 'export', basePath: '/headroom', images: { unoptimized: true } to next.config.mjs
  • Use staticGET for search route (static export compatible)
  • Create missing docs/lib/ modules: source.ts, layout.shared.ts, shared.ts, cn.ts, telemetry.ts
  • Add !docs/lib/ exception to root .gitignore (lib/ was ignored for Python build artifacts)

Note

After merging, GitHub Pages source must be set to "GitHub Actions" in repo Settings → Pages (not "Deploy from branch") for the new workflow to deploy correctly.

Build verified locally — 108 static pages generated successfully.

MkDocs workflow was deploying empty pages since Apr 12 commit (911eb85)
moved all .md content to wiki/ and replaced with Fumadocs .mdx files,
but never updated the CI workflow or created the missing docs/lib/ files.

- Switch docs.yml workflow from MkDocs to Next.js static export
- Add output: 'export', basePath: '/headroom', unoptimized images
- Use staticGET for search route (static export compatible)
- Create docs/lib/ modules: source, layout.shared, shared, cn, telemetry
- Add !docs/lib/ exception to root .gitignore (lib/ was ignored for Python)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant