# milyd/milyovh architecture

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

- Interactive diagram: https://gitdiagram.com/milyd/milyovh
- Repository: https://github.com/milyd/milyovh

## Overview

##### Main components
- Personal Website Frontend (Content)
- Markdown pages (e.g., index.md, about-me.md, hardware.md, test.md, karmelek.md, projects.md)
- HTML layout files under _layouts (default.html, header.html, footer.html)
- Configuration & Data
- Jekyll configuration file (_config.yml)
- Data files in the _data folder (hardware.yaml, navigation.yaml, projects.yaml) which drive dynamic content
- Assets
- CSS files (assets/css folder – aos.css, custom.css)
- JavaScript files (assets/js folder – aos.js)
- Image files (assets/img folder)
- Supporting Files
- Gemfile and Gemfile.lock for dependency management (Ruby gems for Jekyll)
- Miscellaneous static files (404.html, sitemap.xml, robots.txt)
- Deployment Context
- The site is likely hosted using GitHub Pages or similar deployment for static sites

##### Relationships and interactions
- The Jekyll configuration (_config.yml) directs how the content pages, layouts, and data integrate together.
- Markdown files are processed with the corresponding Liquid templates from _layouts to produce the final HTML.
- The _data files feed dynamic content into pages via Liquid templating.
- Assets (CSS, JS, images) are integrated within the HTML during build-time to style and add interactivity.
- External dependencies are defined in the Gemfile, with Jekyll and related libraries being crucial.

##### Important architectural patterns and design principles
- The Model-View-Like separation: Content (Markdown files and _data) is kept separate from presentation (layouts and assets).
- Standard static site generation flow: source files are compiled into a static HTML website.
- Reusability and modularity are promoted through modular layout components (header, footer, default) and data files.

##### Incorporate relevant technologies and frameworks
- Jekyll as a static site generator (Ruby-based)
- Liquid templating for merging content with layouts
- Standard web technologies for the frontend (HTML, CSS, JavaScript)
- RubyGems (indicated by Gemfile/Gemfile.lock) for dependency management

##### Detail and Clarity
- That every component—ranging from content files to assets—is represented.
- Even though the project is relatively straightforward (a personal static website), capturing each element explicitly makes it easier for future maintainers or collaborators to understand the full system architecture.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Content Layer
    subgraph "Content Layer"
        %% Markdown Files Subgraph
        subgraph "Markdown Files"
            index_md["index.md"]:::markdown
            about_me_md["about-me.md"]:::markdown
            hardware_md["hardware.md"]:::markdown
            test_md["test.md"]:::markdown
            karmelek_md["karmelek.md"]:::markdown
            projects_md["projects.md"]:::markdown
        end
        %% Data Files Subgraph
        subgraph "Data Files"
            hardware_yaml["_data/hardware.yaml"]:::data
            navigation_yaml["_data/navigation.yaml"]:::data
            projects_yaml["_data/projects.yaml"]:::data
        end
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        %% Layouts Subgraph
        subgraph "Layouts"
            default_html["_layouts/default.html"]:::layout
            header_html["_layouts/header.html"]:::layout
            footer_html["_layouts/footer.html"]:::layout
        end
        %% Assets Subgraph
        subgraph "Assets"
            css_aos["assets/css/aos.css"]:::asset
            css_custom["assets/css/custom.css"]:::asset
            js_aos["assets/js/aos.js"]:::asset
            img_folder["assets/img"]:::asset
        end
    end

    %% Configuration & Build Layer
    subgraph "Configuration & Build Layer"
        config_yml["_config.yml"]:::config
        %% Dependency Management Subgraph
        subgraph "Dependency Management"
            gemfile["Gemfile"]:::dependency
            gemfile_lock["Gemfile.lock"]:::dependency
        end
        build_process["Jekyll Build Process"]:::build
    end

    %% Static Files and Deployment
    subgraph "Static & Deployment"
        %% Miscellaneous Static Files Subgraph
        subgraph "Misc Static Files"
            file_404["404.html"]:::static
            sitemap_xml["sitemap.xml"]:::static
            robots_txt["robots.txt"]:::static
        end
        deployment["GitHub Pages"]:::deployment
    end

    rendered_html["Rendered HTML"]:::build

    %% Arrows from Content Layer to Build Process
    index_md -->|"Liquid_templating"| build_process
    about_me_md -->|"Liquid_templating"| build_process
    hardware_md -->|"Liquid_templating"| build_process
    test_md -->|"Liquid_templating"| build_process
    karmelek_md -->|"Liquid_templating"| build_process
    projects_md -->|"Liquid_templating"| build_process

    hardware_yaml -->|"Data_injection"| build_process
    navigation_yaml -->|"Data_injection"| build_process
    projects_yaml -->|"Data_injection"| build_process

    %% Arrows from Configuration and Dependency to Build Process
    config_yml -->|"configures"| build_process
    gemfile -->|"dependency"| build_process
    gemfile_lock -->|"dependency"| build_process

    %% Arrows from Build Process to Rendered HTML
    build_process -->|"applies_templates"| rendered_html

    %% Arrows from Layouts to Rendered HTML (Template Inclusion)
    default_html -->|"template"| rendered_html
    header_html -->|"template"| rendered_html
    footer_html -->|"template"| rendered_html

    %% Arrows from Assets to Rendered HTML (Asset Integration)
    css_aos -->|"includes_assets"| rendered_html
    css_custom -->|"includes_assets"| rendered_html
    js_aos -->|"includes_assets"| rendered_html
    img_folder -->|"includes_assets"| rendered_html

    %% Arrows from Misc Static Files to Rendered HTML
    file_404 -->|"static_includes"| rendered_html
    sitemap_xml -->|"static_includes"| rendered_html
    robots_txt -->|"static_includes"| rendered_html

    %% Arrow from Rendered HTML to Deployment
    rendered_html -->|"deploys"| deployment

    %% Styles
    classDef markdown fill:#ccf,stroke:#333,stroke-width:1px;
    classDef data fill:#ddf,stroke:#333,stroke-width:1px;
    classDef layout fill:#cfc,stroke:#333,stroke-width:1px;
    classDef asset fill:#fcf,stroke:#333,stroke-width:1px;
    classDef config fill:#dfd,stroke:#333,stroke-width:1px;
    classDef build fill:#ffd,stroke:#333,stroke-width:1px;
    classDef dependency fill:#fdd,stroke:#333,stroke-width:1px;
    classDef static fill:#eee,stroke:#333,stroke-width:1px;
    classDef deployment fill:#efe,stroke:#333,stroke-width:1px;

click index_md "https://github.com/milyd/milyovh/blob/main/index.md"
click about_me_md "https://github.com/milyd/milyovh/blob/main/about-me.md"
click hardware_md "https://github.com/milyd/milyovh/blob/main/hardware.md"
click test_md "https://github.com/milyd/milyovh/blob/main/test.md"
click karmelek_md "https://github.com/milyd/milyovh/blob/main/karmelek.md"
click projects_md "https://github.com/milyd/milyovh/blob/main/projects.md"
click default_html "https://github.com/milyd/milyovh/blob/main/_layouts/default.html"
click header_html "https://github.com/milyd/milyovh/blob/main/_layouts/header.html"
click footer_html "https://github.com/milyd/milyovh/blob/main/_layouts/footer.html"
click config_yml "https://github.com/milyd/milyovh/blob/main/_config.yml"
click hardware_yaml "https://github.com/milyd/milyovh/blob/main/_data/hardware.yaml"
click navigation_yaml "https://github.com/milyd/milyovh/blob/main/_data/navigation.yaml"
click projects_yaml "https://github.com/milyd/milyovh/blob/main/_data/projects.yaml"
click css_aos "https://github.com/milyd/milyovh/blob/main/assets/css/aos.css"
click css_custom "https://github.com/milyd/milyovh/blob/main/assets/css/custom.css"
click js_aos "https://github.com/milyd/milyovh/blob/main/assets/js/aos.js"
click img_folder "https://github.com/milyd/milyovh/tree/main/assets/img"
click gemfile "https://github.com/milyd/milyovh/tree/main/Gemfile"
click gemfile_lock "https://github.com/milyd/milyovh/blob/main/Gemfile.lock"
click file_404 "https://github.com/milyd/milyovh/blob/main/404.html"
click sitemap_xml "https://github.com/milyd/milyovh/blob/main/sitemap.xml"
click robots_txt "https://github.com/milyd/milyovh/blob/main/robots.txt"
```
