75042a8efb
Add GitHub Pages documentation site with MkDocs Material
...
Generated professional documentation site structure:
- mkdocs.yml: Material theme with dark/light mode, search, navigation
- docs/: Complete documentation sync from DOCS/ (13 files + archive)
- docs/stylesheets/extra.css: SecuBox custom styling (indigo/violet)
- docs/archive/: Archived historical documents (4 files)
Features:
- Material Design theme matching SecuBox design system
- Dark/Light mode toggle with indigo/purple palette
- Advanced navigation (tabs, sections, instant loading)
- Search with suggestions and highlighting
- Mermaid diagram support for architecture visuals
- Code syntax highlighting with copy button
- Mobile responsive layout
- Custom CSS with gradient headings and card effects
Setup:
- Updated scripts/setup-github-pages.sh for Ubuntu 24.04 compatibility
- Added dependency check and auto-install (apt or pip)
- Fixed Python externally-managed-environment handling
- Updated .gitignore to exclude site/, .venv/, docs/.DS_Store
Next steps:
1. Test locally: mkdocs serve
2. Enable GitHub Pages: Settings → Pages → Source: master, Folder: /docs
3. Site will be live at: https://gkerma.github.io/secubox-openwrt/
🤖 Generated with [Claude Code](https://claude.com/claude-code )
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-28 10:06:23 +01:00
dcdbd7bca6
docs: Add GitHub Wiki and Pages setup automation
...
Add comprehensive documentation publishing infrastructure with two deployment
options: GitHub Wiki (quick) and GitHub Pages (professional).
## New Files
### Setup Scripts
- **scripts/setup-wiki.sh** - Automated GitHub Wiki deployment
* Clones wiki repository
* Creates Home page with navigation
* Creates sidebar (_Sidebar.md)
* Copies all DOCS/ files
* Fixes internal links for wiki format
* Auto-commits and pushes
- **scripts/setup-github-pages.sh** - GitHub Pages with MkDocs Material
* Checks/installs dependencies (Python, MkDocs)
* Creates mkdocs.yml configuration
* Generates docs/ directory structure
* Creates professional home page with cards
* Copies and transforms all DOCS/ files
* Adds custom CSS matching SecuBox design
* Builds preview site
* Ready for GitHub Pages deployment
### Documentation
- **WIKI-SETUP-GUIDE.md** - Complete setup guide
* Comparison of Wiki vs GitHub Pages
* Step-by-step instructions for both options
* Customization guides
* Troubleshooting section
* CI/CD automation examples
- **scripts/README.md** - Scripts documentation
* Quick start for both options
* Feature comparison
* Update procedures
* Troubleshooting
## Features
### GitHub Wiki Option
✅ 2-minute setup
✅ No dependencies (Git only)
✅ Auto-sync from DOCS/
✅ Sidebar navigation
✅ Archive organization
✅ Link fixing automation
### GitHub Pages Option (Recommended)
✅ MkDocs Material theme
✅ Dark/Light mode support
✅ Professional navigation (tabs + sidebar)
✅ Search functionality
✅ Mermaid diagram support
✅ Mobile responsive
✅ Custom domain support
✅ SEO optimized
✅ Custom CSS matching SecuBox design
✅ Archive section
## Deployment Options
**Quick (Wiki):**
```bash
./scripts/setup-wiki.sh
# → https://github.com/gkerma/secubox-openwrt/wiki
```
**Professional (Pages):**
```bash
./scripts/setup-github-pages.sh
mkdocs serve # Test locally
# → https://gkerma.github.io/secubox-openwrt/
```
## Benefits
✅ One-command documentation publishing
✅ Two deployment options (quick vs professional)
✅ Automated link fixing for both formats
✅ Complete documentation coverage
✅ Professional appearance (Pages option)
✅ Easy updates (re-run script)
✅ CI/CD ready
🤖 Generated with [Claude Code](https://claude.com/claude-code )
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2025-12-28 10:00:05 +01:00
