diff --git a/docs/deployment/mkdocs.md b/docs/deployment/mkdocs.md new file mode 100644 index 0000000..11233de --- /dev/null +++ b/docs/deployment/mkdocs.md @@ -0,0 +1,150 @@ +# MkDocs Deployment - docs.firefrostgaming.com + +**Date:** February 9, 2026 +**Server:** Ghost VPS (64.50.188.14) +**Status:** ✅ OPERATIONAL +**Service:** 4/7 (Phase 0.5: 57% complete) + +--- + +## Deployment Summary + +**Duration:** ~20 minutes +**Components Installed:** +- MkDocs 1.6.1 +- Material Theme 9.7.1 +- Python 3.12.3 +- Certbot (Let's Encrypt) + +**URLs:** +- Production: https://docs.firefrostgaming.com +- Local: /var/www/mkdocs/docs-site + +--- + +## Installation Steps + +1. **Python & Dependencies** +```bash + apt update && apt install -y python3-pip python3-venv + pip3 install mkdocs mkdocs-material --break-system-packages +``` + +2. **Site Creation** +```bash + mkdir -p /var/www/mkdocs + cd /var/www/mkdocs + mkdocs new docs-site +``` + +3. **Theme Configuration** + - Theme: Material (slate scheme) + - Colors: Firefrost brand (cyan primary, deep orange accent) + - Features: Navigation tabs, search, TOC integration + - Custom CSS: /docs/stylesheets/extra.css + +4. **Content Created** + - Home page (Fire + Frost branding) + - Getting Started guide + - Server Rules + +5. **Build** +```bash + cd docs-site + mkdocs build --clean +``` + +6. **Nginx Configuration** + - Site: /etc/nginx/sites-available/docs.firefrostgaming.com + - Root: /var/www/mkdocs/docs-site/site + - Security headers enabled + +7. **SSL Certificate** + - Provider: Let's Encrypt + - Expires: May 11, 2026 + - Verify return code: 0 (ok) + - Auto-renewal: Configured + +--- + +## Verification Tests + +✅ HTTP → HTTPS redirect working +✅ HTTPS serving correctly (HTTP/2 200) +✅ SSL certificate valid (Verify return code: 0) +✅ Security headers active (X-Frame-Options, X-Content-Type-Options) +✅ DNS resolves to 64.50.188.14 +✅ Nginx stable and running +✅ Brand colors applied (Frost theme) +✅ Visual enhancements added + +--- + +## Brand Customization + +**Colors Applied (Design Bible v1.1):** +- Primary: #00E5FF (Electric Cyan) +- Background: Dark slate +- Accent: #FF3D00 (Deep Orange/Red) + +**Visual Enhancements:** +- Fire + Frost dual-column layout +- Emoji branding (🔥❄️) +- Color-coded path descriptions +- Call-to-action sections + +--- + +## File Structure +``` +/var/www/mkdocs/docs-site/ +├── docs/ +│ ├── index.md (Home with Fire+Frost branding) +│ ├── getting-started.md +│ ├── rules.md +│ └── stylesheets/ +│ └── extra.css (Firefrost brand colors) +├── site/ (built HTML) +└── mkdocs.yml (configuration) +``` + +--- + +## Maintenance + +**Update Content:** +```bash +cd /var/www/mkdocs/docs-site +# Edit files in docs/ +mkdocs build --clean +``` + +**Add New Page:** +```bash +# Create docs/new-page.md +# Add to mkdocs.yml under nav: +mkdocs build --clean +``` + +--- + +## Known Issues + +**Browser "Not secure" warning (Chrome-specific):** +- Server SSL is valid (Verify return code: 0) +- Certificate from Let's Encrypt is trusted +- Issue: Browser cache/extension interference +- Fix: Clear Chrome SSL cache (chrome://net-internals) + +--- + +## Next Steps + +- Integrate with Gitea (auto-build on commit) +- Add modpack-specific documentation +- Create subscriber-only content markers +- Link to Wiki.js for premium content + +--- + +**Fire + Frost = Where Passion Meets Precision** 🔥❄️