# bsenst/praxis-it architecture

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

- Interactive diagram: https://gitdiagram.com/bsenst/praxis-it
- Repository: https://github.com/bsenst/praxis-it

## Overview

##### Project type and purpose
- This is a static documentation/book site built with Quarto (“Praxis-IT” Quarto book).
- Source content lives in `.qmd` (Quarto Markdown) files; the final site is rendered to HTML and deployed via GitHub Pages.

##### File structure
- Top-level files:
- `_quarto.yml` (Quarto project configuration)
- `README.md` (project overview)
- `.github/workflows/publish.yml` (CI workflow for build & deploy)
- `.nojekyll` (instructs GitHub Pages not to use Jekyll)
- Content directory: dozens of `*.qmd` files (chapters), an `assets/` folder for images/CSS/JS, plus citation files (`referenzen.bib`, `referenzen.qmd`).
- Build tooling: Quarto CLI invoked in CI to convert `.qmd` → HTML.

##### README
- Confirms use of Quarto CLI and GitHub Codespaces for local dev.
- Deployment target is GitHub Pages (via `publish.yml`).

##### Main components and interactions
a. Source content
- `.qmd` files (chapters, sections)
- `_quarto.yml` (book layout, theme, navigation)
- `assets/` (images, styles, GTM snippets)
- citation files
b. Build environment
- Developer workstation or GitHub Codespaces (with Quarto CLI + TinyTeX)
- Quarto CLI: processes `.qmd` + config → HTML site
c. CI/CD pipeline
- GitHub Actions (`publish.yml`): triggers on push, runs Quarto build steps
- Installs Quarto CLI, runs `quarto render`, archives output
- Publishes to GitHub Pages branch
d. Hosting
- GitHub Pages serves the generated static HTML at `https://bsenst.github.io/praxis-it`

##### Architectural patterns/design principles
- Static Site Generation (SSG): content separated from rendering logic
- CI/CD for reproducible builds and automated deployment
- Single‐repository monolith for content, build scripts, and deployment config
- Clear separation of concerns: content (QMD) vs. tooling (Quarto CLI) vs. infrastructure (GitHub Actions + Pages)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Development Environment"
        Dev["Developer / Codespace\nQuarto CLI + TinyTeX"]:::dev
    end

    subgraph "GitHub Repository"
        content(("Source Content\n(.qmd files)")):::data
        config["Quarto Config\n(_quarto.yml)"]:::config
        assets["Assets Directory"]:::assets
        gtm_head["GTM Snippets Head"]:::assets
        gtm_body["GTM Snippets Body"]:::assets
        bib["referenzen.bib"]:::data
        qmd_cite["referenzen.qmd"]:::data
        workflow["CI/CD Workflow\n(publish.yml)"]:::ci
        nogeek[".nojekyll"]:::repo
        readme["README.md"]:::repo
        gitignore[".gitignore"]:::repo
    end

    CI["GitHub Actions (CI)\n• Install Quarto CLI\n• quarto render . --to html\n• Publish to Pages"]:::ci

    Pages["GitHub Pages\nStatic Site Hosting"]:::hosting

    User["End User Browser"]:::user

    Dev -->|git push to main| workflow
    workflow -->|"deploy to Pages"| Pages
    Pages -->|"serves site"| User

    click content "https://github.com/bsenst/praxis-it/blob/main//*.qmd"
    click config "https://github.com/bsenst/praxis-it/blob/main//_quarto.yml"
    click assets "https://github.com/bsenst/praxis-it/tree/main//assets/"
    click gtm_head "https://github.com/bsenst/praxis-it/blob/main//gtm_code_head.html"
    click gtm_body "https://github.com/bsenst/praxis-it/blob/main//gtm_code_body.html"
    click bib "https://github.com/bsenst/praxis-it/blob/main//referenzen.bib"
    click qmd_cite "https://github.com/bsenst/praxis-it/blob/main//referenzen.qmd"
    click workflow "https://github.com/bsenst/praxis-it/blob/main//.github/workflows/publish.yml"
    click nogeek "https://github.com/bsenst/praxis-it/blob/main//.nojekyll"
    click readme "https://github.com/bsenst/praxis-it/blob/main//README.md"
    click gitignore "https://github.com/bsenst/praxis-it/blob/main//.gitignore"

    classDef dev fill:#add8e6,stroke:#0000ff
    classDef config fill:#98fb98,stroke:#008000
    classDef repo fill:#98fb98,stroke:#008000
    classDef assets fill:#d3d3d3,stroke:#666666
    classDef data fill:#d3d3d3,stroke:#666666
    classDef ci fill:#ffa500,stroke:#d2691e
    classDef hosting fill:#dda0dd,stroke:#800080
    classDef user fill:#f0f0f0,stroke:#000000
```
