How johanbook/docs works
Main Components
a. Client-Side Components:
• Web Browser (User Interface)
• Static Site Assets (HTML, CSS, JavaScript)
• Documentation Content (Markdown files)
b. Build/Development Components:
• Docusaurus Framework
• Node.js Runtime
• Markdown Processor
• GitHub Pages (Hosting)
c. CI/CD Components:
• GitHub Actions
• Build Pipeline
• Deployment Process
[Web Browser] → [CDN/GitHub Pages] → [Static Assets]
[Markdown Files] → [Docusaurus] → [Static Site Generator] → [Compiled Assets]
[GitHub Repository] → [GitHub Actions] → [Build Process] → [Deploy to GitHub Pages]
Important Details
a. Content Organization:
• Documentation structure (ai, architecture, databases, etc.)
• Markdown processing flow
b. Build Process:
• Node.js v16 LTS runtime
• NPM package management
• Docusaurus configuration
c. Deployment:
• GitHub Actions workflow
• GitHub Pages hosting
• Uptime monitoring integration
Notes
Annotations for:
• The Node.js version requirement
• The markdown compilation process
• The GitHub Pages hosting configuration
• The uptime monitoring integration