Skip to content

feat: migrate from Gitbook to MkDocs Material with i18n#42

Merged
openoms merged 17 commits intoopenoms:enfrom
autoblitzbot:mkdocs-migration
Mar 1, 2026
Merged

feat: migrate from Gitbook to MkDocs Material with i18n#42
openoms merged 17 commits intoopenoms:enfrom
autoblitzbot:mkdocs-migration

Conversation

@autoblitzbot
Copy link
Collaborator

Summary

  • Migrates the site from Gitbook to MkDocs Material with the mkdocs-static-i18n plugin
  • English content moved from root into docs/
  • Spanish content from the es branch merged into docs/es/, with directory names mapped to match the EN structure so the i18n plugin pairs pages correctly
  • Language switcher dropdown (EN/ES) with translated navigation labels
  • Dark/light theme toggle, search, code copy, and all Material features
  • Custom domain (lightningnode.info) preserved via CNAME
  • All hardware sub-pages (RaspiBlitz, TrueNAS tools) included in navigation

What's needed after merge

The GitHub Actions workflow (deploy.yml) couldn't be pushed due to OAuth token scope limitations. To enable auto-deployment:

  1. Create .github/workflows/deploy.yml — the file content is in the first commit of this branch (commit 7c6fbe2)
  2. Enable GitHub Pages in repo settings → set source to "GitHub Actions"
  3. The workflow installs mkdocs-material + mkdocs-static-i18n and deploys on push to main

Alternatively, the workflow file is saved locally and can be pushed with a token that has the workflow scope.

Local testing

python3 -m venv .venv && source .venv/bin/activate
pip install mkdocs-material mkdocs-static-i18n
mkdocs serve

Then visit http://127.0.0.1:8000 — language toggle is in the top bar.

Test plan

  • Verify EN pages render correctly at /
  • Verify ES pages render at /es/
  • Test language switcher toggles between EN/ES
  • Confirm images/assets load on both language versions
  • Check custom domain (lightningnode.info) still works after Pages setup

- Set up MkDocs Material with mkdocs-static-i18n plugin
- Migrate EN content from root into docs/
- Migrate ES content from es branch into docs/es/ with
  directory names mapped to match EN structure
- Add GitHub Actions workflow for Pages deployment
- Fix internal links and asset references
- Include all hardware sub-pages in navigation
- Dark/light theme toggle, search, code copy
- Language switcher (EN/ES) with nav translations
- CNAME preserved for lightningnode.info
The GitHub Actions deploy workflow will be added once the token
has the workflow scope, or it can be created via the GitHub UI.
- deploy.yml triggers on push to mkdocs-migration branch
- mkdocs.yml includes hu locale with nav translations
Complete hu locale under docs/hu/ mirroring the full English content:
- Lightning basics, liquidity, channel markets
- Node types, advanced tools, technicals
- Recovery (LND + CLN), privacy, hardware guides
- RaspiBlitz, RaspiBolt, TrueNAS sub-pages
- Donate page
All 33 Hungarian doc files were missing ékezetek (diacritical marks).
Fixed á, é, í, ó, ö, ő, ú, ü, ű across all translated content.
All content already migrated to docs/ for MkDocs.
Removes duplicate root files, .gitbook/, SUMMARY.md, and root CNAME.

Repo structure is now:
  docs/         ← EN content + es/, hu/ translations
  mkdocs.yml
  README.md
  .github/
@openoms openoms merged commit 5f6d5fb into openoms:en Mar 1, 2026
1 check passed
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.

2 participants