How eclipse-epsilon/epsilon-website works
Main Components
a. Static Site Generator Layer
• MkDocs Engine (core documentation generation)
• Custom Theme Components
• Asset Processing (JavaScript, CSS, Images)
b. Interactive Components
• Epsilon Playground System
• Search Functionality
• Code Highlighting System
c. Content Management Layer
• Documentation Sources (Markdown)
• Examples and Templates
• Configuration Files
a. Use a three-tier vertical layout:
• Top Tier: End-User Interface (Browser)
• Middle Tier: Static Site Generation & Build Process
• Bottom Tier: Content Sources & Assets
Key Relationships
a. Build Flow:
• Content Sources → MkDocs Engine → Static HTML
• Assets → Asset Processing → Optimized Assets
• Templates → Playground Generation → Interactive Features
b. Runtime Flow:
• User Requests → Static Content Serving
• Playground Interactions → Backend Processing
• Search Queries → Search Index
Specific components
[Browser Layer]
• ↑
[Static Content Delivery]
• ↑
[Build Process]
• MkDocs Engine
• Custom Theme
• Asset Pipeline
• ↑
[Source Components]
• Documentation (doc/)
• Playground (playground/)
• Assets (assets/)
• Configuration (mkdocs.yml)
Technical Details
• JavaScript-based components (highlighting, playground)
• Asset processing pipeline
• Documentation structure and organization
• Build and deployment workflow