# ddad431/s3 architecture

> Architecture diagram of the GitHub repository ddad431/s3, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ddad431/s3
- Repository: https://github.com/ddad431/s3

## Overview

S3 is a command-line static-site generator. Users can initialize a site directory, inspect its required layout, or build Markdown pages into a static site. The build flow checks and cleans the site, copies theme assets, then renders the index and topic posts. Page rendering converts Markdown and metadata into page data before applying templates. Shared path and file helpers support the commands. The README is empty, so capabilities and relationships here are based on the sampled source; unsampled command details are not inferred.

Main entry points: [`cmd/ssg/build.go`](https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go) (Build site), [`cmd/ssg/main.go`](https://github.com/ddad431/s3/blob/main/cmd/ssg/main.go) (Command dispatch), [`cmd/ssg/init.go`](https://github.com/ddad431/s3/blob/main/cmd/ssg/init.go) (Initialize site), [`cmd/ssg/page.go`](https://github.com/ddad431/s3/blob/main/cmd/ssg/page.go) (Page assembly)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI commands"]
  node_cli["Command dispatch<br/>[main.go]"]
  node_build["Build site<br/>[build.go]"]
  node_assets["Theme assets<br/>[build.go]"]
  node_output["Generated site<br/>[build.go]"]
end

subgraph group_site["Site setup"]
  node_init["Initialize site<br/>[init.go]"]
  node_doctor["Check layout<br/>[doctor.go]"]
  node_template_setup["Template creation<br/>[template.go]"]
end

subgraph group_render["Page rendering"]
  node_embedded["Default templates"]
  node_page["Page assembly<br/>[page.go]"]
  node_converter["Markdown conversion<br/>[convert.go]"]
end

subgraph group_shared["Shared utilities"]
  node_layout["Layout checks<br/>[share.go]"]
end

node_user(("Site author"))

node_user -->|"runs command"| node_cli
node_cli -->|"dispatches"| node_init
node_cli -->|"dispatches"| node_doctor
node_cli -->|"dispatches"| node_build
node_init -->|"checks paths"| node_layout
node_doctor -->|"checks paths"| node_layout
node_init -->|"creates templates"| node_template_setup
node_template_setup -->|"reads embedded files"| node_embedded
node_build -->|"checks layout"| node_layout
node_build -->|"copies assets"| node_assets
node_build -->|"builds pages"| node_page
node_page -->|"converts Markdown"| node_converter
node_page -->|"writes rendered pages"| node_output
node_build -->|"creates build directory"| node_output

click node_cli "https://github.com/ddad431/s3/blob/main/cmd/ssg/main.go"
click node_init "https://github.com/ddad431/s3/blob/main/cmd/ssg/init.go"
click node_doctor "https://github.com/ddad431/s3/blob/main/cmd/ssg/doctor.go"
click node_build "https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go"
click node_layout "https://github.com/ddad431/s3/blob/main/cmd/ssg/share.go"
click node_embedded "https://github.com/ddad431/s3/tree/main/cmd/ssg/templates"
click node_template_setup "https://github.com/ddad431/s3/blob/main/cmd/ssg/template.go"
click node_page "https://github.com/ddad431/s3/blob/main/cmd/ssg/page.go"
click node_converter "https://github.com/ddad431/s3/blob/main/cmd/ssg/convert.go"
click node_assets "https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go"
click node_output "https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_build,node_assets,node_output toneBlue
class node_init,node_doctor,node_template_setup toneAmber
class node_embedded,node_page,node_converter toneMint
class node_layout toneRose
class node_user toneIndigo
```

## Components

### CLI commands

- [Command dispatch](https://github.com/ddad431/s3/blob/main/cmd/ssg/main.go): `cmd/ssg/main.go`
- [Build site](https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go): `cmd/ssg/build.go`
- [Theme assets](https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go): `cmd/ssg/build.go`
- [Generated site](https://github.com/ddad431/s3/blob/main/cmd/ssg/build.go): `cmd/ssg/build.go`

### Site setup

- [Initialize site](https://github.com/ddad431/s3/blob/main/cmd/ssg/init.go): `cmd/ssg/init.go`
- [Check layout](https://github.com/ddad431/s3/blob/main/cmd/ssg/doctor.go): `cmd/ssg/doctor.go`
- [Template creation](https://github.com/ddad431/s3/blob/main/cmd/ssg/template.go): `cmd/ssg/template.go`

### Page rendering

- [Default templates](https://github.com/ddad431/s3/tree/main/cmd/ssg/templates): `cmd/ssg/templates`
- [Page assembly](https://github.com/ddad431/s3/blob/main/cmd/ssg/page.go): `cmd/ssg/page.go`
- [Markdown conversion](https://github.com/ddad431/s3/blob/main/cmd/ssg/convert.go): `cmd/ssg/convert.go`

### Shared utilities

- [Layout checks](https://github.com/ddad431/s3/blob/main/cmd/ssg/share.go): `cmd/ssg/share.go`

### Other components

- **Site author**

## Connections

- Site author → Command dispatch: runs command (evidence: `cmd/ssg/main.go`)
- Command dispatch → Initialize site: dispatches (evidence: `cmd/ssg/main.go`)
- Command dispatch → Check layout: dispatches (evidence: `cmd/ssg/main.go`)
- Command dispatch → Build site: dispatches (evidence: `cmd/ssg/main.go`)
- Initialize site → Layout checks: checks paths (evidence: `cmd/ssg/init.go`)
- Check layout → Layout checks: checks paths (evidence: `cmd/ssg/doctor.go`)
- Initialize site → Template creation: creates templates (evidence: `cmd/ssg/init.go`)
- Template creation → Default templates: reads embedded files (evidence: `cmd/ssg/template.go`)
- Build site → Layout checks: checks layout (evidence: `cmd/ssg/build.go`)
- Build site → Theme assets: copies assets (evidence: `cmd/ssg/build.go`)
- Build site → Page assembly: builds pages (evidence: `cmd/ssg/build.go`)
- Page assembly → Markdown conversion: converts Markdown (evidence: `cmd/ssg/page.go`)
- Page assembly → Generated site: writes rendered pages (evidence: `cmd/ssg/page.go`)
- Build site → Generated site: creates build directory (evidence: `cmd/ssg/build.go`)
