Skip to content

add GitHub Pages wiki site#23

Merged
kicka5h merged 1 commit intomainfrom
claude/python-snacks-wiki-pages-gtkZQ
Mar 18, 2026
Merged

add GitHub Pages wiki site#23
kicka5h merged 1 commit intomainfrom
claude/python-snacks-wiki-pages-gtkZQ

Conversation

@kicka5h
Copy link
Copy Markdown
Owner

@kicka5h kicka5h commented Mar 18, 2026

Summary

Adds a static GitHub Pages site under docs/ that serves the existing wiki content as a browsable, single-page wiki using native JavaScript.

Changes

  • Create docs/index.html — single-page wiki app with sidebar navigation, hash-based routing, and responsive mobile layout
  • Copy all 7 wiki markdown files into docs/wiki/ for static serving
  • Use marked.js and highlight.js via CDN for markdown rendering and syntax highlighting
  • Support [[Page]] wiki-link syntax, converting them to internal hash links
  • Preload all wiki pages in the background after initial page load
  • Update .github/workflows/wiki.yml to sync wiki/*.md into docs/wiki/ on push, keeping the Pages site in sync with wiki source

Test plan

  • Existing tests pass (pytest tests/ -v)
  • New tests added for any new behaviour
  • Tested manually with a real stash
  • Open docs/index.html locally and verify all 7 wiki pages load and render correctly
  • Verify sidebar navigation and hash routing (#Installation, #Commands-Reference, etc.)
  • Verify code blocks have syntax highlighting
  • Verify [[Page]] wiki-links resolve to internal navigation
  • Test responsive layout at mobile widths

Notes for reviewer

  • No new Python code or dependencies — this is purely a static HTML/JS/CSS addition
  • Markdown rendering uses marked.js and highlight.js from CDN (no vendored files)
  • To enable GitHub Pages after merge: Settings > Pages > Deploy from branch main, folder /docs
  • The wiki workflow now has a second step that commits synced files back to the repo; this keeps docs/wiki/ up to date automatically when wiki/*.md changes

- Create docs/index.html as a single-page wiki with sidebar navigation
- Copy wiki markdown files to docs/wiki/ for static serving
- Use marked.js + highlight.js via CDN for markdown rendering
- Hash-based routing between wiki pages with preloading
- Update wiki workflow to sync wiki/ content into docs/wiki/
- Responsive layout with mobile hamburger menu

https://claude.ai/code/session_01BgQZR5yFQxP94gNvDkvavs
@kicka5h kicka5h merged commit 04d4d2b into main Mar 18, 2026
3 checks passed
@kicka5h kicka5h deleted the claude/python-snacks-wiki-pages-gtkZQ branch March 18, 2026 05:52
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