# eclipse-epsilon/epsilon-website architecture

> Architecture diagram of the GitHub repository eclipse-epsilon/epsilon-website, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/eclipse-epsilon/epsilon-website
- Repository: https://github.com/eclipse-epsilon/epsilon-website

## Overview

##### 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

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Browser
        UI[User Interface]
        PG[Playground Interface]
        SR[Search Results]
    end

    subgraph "Static Site Generation"
        MK[MkDocs Engine]:::mkdocs
        TH[Custom Theme]:::theme
        AP[Asset Processing]:::assets
        PGB[Playground Builder]:::playground
        SG[Search Generator]:::search
        CH[Code Highlighter]:::highlighter
    end

    subgraph "Content & Assets"
        DS[Documentation Sources]:::docs
        EX[Examples & Templates]:::examples
        CF[Configuration]:::config
        AS[Assets]:::assets
        SI[Search Index]:::search
    end

    %% Relationships
    UI --> PG
    UI --> SR
    
    MK --> UI
    TH --> UI
    AP --> UI
    PGB --> PG
    SG --> SR
    CH --> UI
    
    DS --> MK
    EX --> PGB
    CF --> MK
    AS --> AP
    SI --> SG

    %% Click Events
    click MK "https://github.com/eclipse-epsilon/epsilon-website/tree/main/mkdocs"
    click TH "https://github.com/eclipse-epsilon/epsilon-website/tree/main/mkdocs/custom_theme"
    click PGB "https://github.com/eclipse-epsilon/epsilon-website/tree/main/playground"
    click CH "https://github.com/eclipse-epsilon/epsilon-website/tree/main/assets/javascript/google-code-prettify"
    click DS "https://github.com/eclipse-epsilon/epsilon-website/tree/main/doc"
    click EX "https://github.com/eclipse-epsilon/epsilon-website/tree/main/playground/examples"
    click CF "https://github.com/eclipse-epsilon/epsilon-website/blob/main/mkdocs/mkdocs.yml"
    click AS "https://github.com/eclipse-epsilon/epsilon-website/tree/main/assets"
    click SI "https://github.com/eclipse-epsilon/epsilon-website/blob/main/search/search_index.json"

    %% Styles
    classDef mkdocs fill:#3498db
    classDef theme fill:#2ecc71
    classDef assets fill:#e67e22
    classDef playground fill:#9b59b6
    classDef search fill:#f1c40f
    classDef highlighter fill:#1abc9c
    classDef docs fill:#e74c3c
    classDef examples fill:#34495e
    classDef config fill:#95a5a6

    %% Legend
    subgraph Legend
        L1[MkDocs]:::mkdocs
        L2[Theme]:::theme
        L3[Assets]:::assets
        L4[Playground]:::playground
        L5[Search]:::search
        L6[Highlighter]:::highlighter
        L7[Documentation]:::docs
        L8[Examples]:::examples
        L9[Configuration]:::config
    end
```
