# maxgripe/skunk-html architecture

> Architecture diagram of the GitHub repository maxgripe/skunk-html, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/maxgripe/skunk-html
- Repository: https://github.com/maxgripe/skunk-html

## Overview

Key Components to Include:

##### Source Components
- Markdown Files (in /markdown-blog/)
- HTML Fragments (in /html/)
- Static Assets (CSS, fonts, scripts)

##### Build Process
- GitHub Actions Trigger
- F# Processing Engine (Program.fs)
- FSharp.Formatting Library integration

##### Output/Deployment
- "Generated Website" component:
- Static HTML output
- GitHub Pages hosting
- Giscus Comments System integration

**[Source Files] → [Build Process] → [Deployment/Output]**

##### Component Relationships
- How Markdown files flow into the F# processor
- How HTML fragments are incorporated
- How static assets are copied
- The deployment flow to GitHub Pages

Detailed Component Breakdown:

**[Source Files]**
- Markdown Content
- /markdown-blog/*.md
- HTML Templates
- /html/*.html
- Static Assets
- /css/
- /fonts/
- /scripts/

**[Build Process]**
- GitHub Actions Trigger
- F# Processing Engine
- Program.fs
- SkunkHtml.fs
- SkunkUtils.fs
- FSharp.Formatting

**[Output/Deployment]**
- Generated Static Site
- skunk-html-output/
- GitHub Pages Hosting
- Giscus Comments

Important Elements to Highlight:

##### Automation Flow
- How GitHub Actions automatically triggers the build process when changes are pushed
- Automated deployment to GitHub Pages

##### Integration Points
- Where external services connect (Giscus comments)
- Where static assets are incorporated
- Template insertion points

##### Processing Pipeline
- Markdown to HTML conversion process
- Where styling and scripts are applied
- Where templates are merged

- Symbols for files, directories, processes, and services

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Source
        MD["Markdown Content"]
        HT["HTML Templates"]
        SA["Static Assets"]
        
        subgraph Assets
            CSS["CSS Files"]
            Fonts["Font Files"]
            Scripts["JavaScript Files"]
        end
        
        SA --> Assets
    end

    subgraph BuildPipeline
        GHA["GitHub Actions"]
        FE["F# Processing Engine"]
        FF["FSharp.Formatting"]
        
        GHA --> FE
        FE --> FF
    end

    subgraph Templates
        Header["Header Template"]
        Footer["Footer Template"]
        Head["Head Section"]
        Title["Page Title"]
    end

    subgraph Integrations
        Giscus["Giscus Comments"]
        Syntax["Syntax Highlighting"]
    end

    subgraph Output
        Static["Generated Static Site"]
        GHP["GitHub Pages"]
        Comments["Comments System"]
    end

    MD --> FE
    HT --> FE
    SA --> Static
    Templates --> FE
    Integrations --> Static
    FE --> Static
    Static --> GHP
    Giscus --> Comments

    %% Click events for component mapping
    click MD "https://github.com/MaxGripe/skunk-html/tree/master//markdown-blog/"
    click HT "https://github.com/MaxGripe/skunk-html/tree/master//html/"
    click CSS "https://github.com/MaxGripe/skunk-html/tree/master//css/"
    click Fonts "https://github.com/MaxGripe/skunk-html/tree/master//fonts/"
    click Scripts "https://github.com/MaxGripe/skunk-html/tree/master//scripts/"
    click GHA "https://github.com/MaxGripe/skunk-html/blob/master//.github/workflows/main.yml"
    click FE "https://github.com/MaxGripe/skunk-html/blob/master//Program.fs"
    click Header "https://github.com/MaxGripe/skunk-html/blob/master//html/header.html"
    click Footer "https://github.com/MaxGripe/skunk-html/blob/master//html/footer.html"
    click Head "https://github.com/MaxGripe/skunk-html/blob/master//html/head.html"
    click Title "https://github.com/MaxGripe/skunk-html/blob/master//html/title.html"
    click Giscus "https://github.com/MaxGripe/skunk-html/blob/master//html/script_giscus.html"
    click Syntax "https://github.com/MaxGripe/skunk-html/blob/master//html/script_syntax_highlighting.html"
    click Scripts "https://github.com/MaxGripe/skunk-html/blob/master//scripts/microlight.js"

    %% Styling
    classDef source fill:#a8d1ff
    classDef build fill:#90EE90
    classDef output fill:#FFB347
    classDef integration fill:#D3D3D3
    classDef template fill:#DDA0DD

    class MD,HT,SA,CSS,Fonts,Scripts source
    class GHA,FE,FF build
    class Static,GHP,Comments output
    class Giscus,Syntax integration
    class Header,Footer,Head,Title template
```
