# oscuro-phoenix/math-for-fun architecture

> Architecture diagram of the GitHub repository oscuro-phoenix/math-for-fun, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oscuro-phoenix/math-for-fun
- Repository: https://github.com/oscuro-phoenix/math-for-fun

## Overview

##### Project type and purpose
- This is a static‐site project built with Jekyll (a Ruby-based static site generator). Its sole purpose is to collect and render Markdown “math problem” posts into a browseable website.

##### File structure
- Top‐level files:
- Gemfile / Gemfile.lock – declare Jekyll and plugin dependencies
- _config.yml – Jekyll configuration (site metadata, plugin settings)
- index.html, about.md, tags.html, 404.html – site entry points and standalone pages
- Directories under Jekyll conventions:
- _posts – Markdown problem posts (content source)
- _drafts – unpublished content
- _layouts – HTML layout templates (e.g., default.html, post.html)
- _includes – reusable HTML partials (header, footer, nav)
- assets – media files (videos)
- css – SCSS source, compiled to site CSS
- notebooks – Jupyter notebooks and Python scripts (auxiliary content)
- Misc:
- google*.html – verification files
- tags.html – auto‐generated tag listing

##### README for additional insights
- Confirms this is “Math-For-Fun,” a simple website to track math problems.
- References a theme “Parchment” inspired by another Jekyll theme.

##### Elements
- Clear rectangular nodes for:
- “Markdown Posts & Pages”
- “_layouts & _includes”
- “assets/css & notebooks”
- “Jekyll Build Engine”
- “_site (Generated Output)”
- “Hosting (GitHub Pages)”
- “Browser / End User”
- From content, templates, assets into “Jekyll Build Engine”
- From build engine to “_site”
- From “_site” to “Hosting”
- From “Hosting” to “Browser”
- Content (blue)
- Templates & includes (green)
- Build engine & toolchain (orange)
- Deployment & hosting (purple)
- End user (gray)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Content Sources
    subgraph "Content Sources"
        direction TB
        Posts["_posts/*.md"]:::content
        Drafts["_drafts/2020-02-27-sample-draft.md"]:::content
        Pages["about.md, index.html, tags.html, 404.html"]:::content
    end

    %% Templates
    subgraph "Templates"
        direction TB
        LayoutDefault["_layouts/default.html"]:::templates
        LayoutPost["_layouts/post.html"]:::templates
        IncludeHead["_includes/head.html"]:::templates
        IncludeNav["_includes/navbar.html"]:::templates
        IncludeFooter["_includes/footer.html"]:::templates
    end

    %% Assets & Ancillary
    subgraph "Assets & Ancillary Content"
        direction TB
        Video1["assets/prob11_vid.mp4"]:::assets
        Video2["assets/prob13_vid.mp4"]:::assets
        Stylesheet["css/main.scss"]:::assets
        Notebook["notebooks/Complex_Mapper.ipynb"]:::assets
        Script["notebooks/complex-mapper.py"]:::assets
    end

    %% Configuration & Dependencies
    subgraph "Build Configuration"
        direction TB
        Config["_config.yml"]:::build
        Gemfile["Gemfile"]:::build
        GemfileLock["Gemfile.lock"]:::build
    end

    %% Build Engine
    Jekyll["Jekyll Build Engine"]:::build

    %% Output
    Site["_site (Generated Output)"]:::output

    %% Deployment
    Hosting["GitHub Pages (Hosting)"]:::deployment

    %% End User
    Browser["Browser / End User"]:::enduser

    %% Connections
    Posts -->|"Markdown → HTML via Liquid"| Jekyll
    Drafts -->|"Markdown → HTML via Liquid"| Jekyll
    Pages -->|"Static pages"| Jekyll
    LayoutDefault -->|"Templates"| Jekyll
    LayoutPost -->|"Templates"| Jekyll
    IncludeHead -->|"Partials"| Jekyll
    IncludeNav -->|"Partials"| Jekyll
    IncludeFooter -->|"Partials"| Jekyll
    Stylesheet -->|"SCSS → CSS"| Jekyll
    Video1 -->|"Assets"| Jekyll
    Video2 -->|"Assets"| Jekyll
    Notebook -->|"Ancillary content"| Jekyll
    Script -->|"Ancillary content"| Jekyll
    Config -->|"Build parameters"| Jekyll
    Gemfile -->|"Bundler dependencies"| Jekyll
    GemfileLock -->|"Bundler dependencies"| Jekyll

    Jekyll -->|"Build output"| Site
    Site -->|"Git push & CI"| Hosting
    Hosting -->|"HTTP GET"| Browser

    %% Click Events
    click Posts "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_posts/*.md"
    click Drafts "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_drafts/2020-02-27-sample-draft.md"
    click LayoutDefault "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_layouts/default.html"
    click LayoutPost "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_layouts/post.html"
    click IncludeHead "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_includes/head.html"
    click IncludeNav "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_includes/navbar.html"
    click IncludeFooter "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_includes/footer.html"
    click Video1 "https://github.com/oscuro-phoenix/math-for-fun/blob/master/assets/prob11_vid.mp4"
    click Video2 "https://github.com/oscuro-phoenix/math-for-fun/blob/master/assets/prob13_vid.mp4"
    click Stylesheet "https://github.com/oscuro-phoenix/math-for-fun/blob/master/css/main.scss"
    click Notebook "https://github.com/oscuro-phoenix/math-for-fun/blob/master/notebooks/Complex_Mapper.ipynb"
    click Script "https://github.com/oscuro-phoenix/math-for-fun/blob/master/notebooks/complex-mapper.py"
    click Config "https://github.com/oscuro-phoenix/math-for-fun/blob/master/_config.yml"
    click Gemfile "https://github.com/oscuro-phoenix/math-for-fun/tree/master/Gemfile"
    click GemfileLock "https://github.com/oscuro-phoenix/math-for-fun/blob/master/Gemfile.lock"

    %% Styles
    classDef content fill:#AED6F1,stroke:#1B4F72,color:#1B4F72
    classDef templates fill:#ABEBC6,stroke:#1D8348,color:#1D8348
    classDef assets fill:#F9E79F,stroke:#B7950B,color:#7D6608
    classDef build fill:#F5CBA7,stroke:#A04000,color:#78281F
    classDef output fill:#D2B4DE,stroke:#512E5F,color:#4A235A
    classDef deployment fill:#D6EAF8,stroke:#1A5276,color:#1B4F72
    classDef enduser fill:#E5E8E8,stroke:#566573,color:#2C3E50
```
