# junian/markdown-resume architecture

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

- Interactive diagram: https://gitdiagram.com/junian/markdown-resume
- Repository: https://github.com/junian/markdown-resume

## Overview

##### Main Components
- Site (Frontend Application):
– Built with Nuxt 3 and Vue 3, this is the core of the application.
– Contains pages, components, assets, and configuration files.
– Implements features like real-time preview, offline PWA support, and PDF export.
- Packages (Modular Libraries):
– Organized under the “packages” directory, each package (e.g., correct-case, dynamic-css, markdown-it-katex, vue-smart-pages, etc.) encapsulates a specific functionality.
– These packages serve as reusable libraries both for the site and potentially for other integrations.
- External Services:
– Google Fonts API: To dynamically load fonts using the user’s developer API key.
- Browser/Local Environment:
– PWA capabilities and local data storage (via libraries like Localforage) to save resume data client-side.

##### Relationships and Interactions
- The Site component (the Nuxt 3 app) is dependent on multiple packages from the monorepo:
– For example, “vue-zoom”, “vue-shortcuts”, and “vue-smart-pages” integrate into the interface.
– Markdown processing and formatting is augmented by packages like “markdown-it-cross-ref”, “markdown-it-latex-cmds”, and “markdown-it-katex”.
- The Site interacts with external services (e.g., Google Fonts) to enhance customization and UI presentation.
- The PWA aspect and offline storage actively work in the browser client, ensuring a smooth, stateful experience.

##### Architectural Patterns and Design Principles
- Monorepo Structure: The design supports modularity and reusability through separate packages, each with its own tsconfig.json and package.json.
- Separation of Concerns: The project clearly delineates UI components (in the “site” directory) from supporting libraries (in “packages”), echoing principles like Single Responsibility.
- Client-Side Data Management: Emphasizes offline-first design, with the resume data handled locally in the browser.
- Progressive Enhancement: The emphasis on PWA and real-time preview highlights a modern reactive design leveraging Vue 3’s reactivity.

##### Relevant Technologies, Frameworks, and Libraries
- Nuxt 3, Vue 3, and Vite for the frontend.
- UnoCSS for utility-first CSS.
- External APIs such as Google Fonts.
- Various helper libraries provided via the modular packages (e.g., for markdown enhancement, case correction, CSS dynamics, LaTeX support via KaTeX, etc.)
- TypeScript for static type checking across packages.

##### Final Advice for the Software Engineer
- Don’t worry about overly complex details. The aim is to capture the essential architectural elements – the separation of concerns between the frontend site and the various utility packages.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Frontend Layer"
        S("Site (Nuxt Frontend)"):::frontend
    end

    subgraph "Packages"
        CC("Correct Case Module"):::package
        DC("Dynamic CSS Module"):::package
        CR("Markdown-it Cross Ref"):::package
        KT("Markdown-it KaTeX Support"):::package
        LC("Markdown-it LaTeX Commands"):::package
        VS("Vue Shortcuts"):::package
        SP("Vue Smart Pages"):::package
        VZ("Vue Zoom"):::package
    end

    subgraph "External Services"
        GF("Google Fonts Loader"):::external
    end

    subgraph "Local/Client"
        PWA("PWA & Local Storage"):::client
    end

    S -->|"uses"| CC
    S -->|"uses"| DC
    S -->|"uses"| CR
    S -->|"uses"| KT
    S -->|"uses"| LC
    S -->|"uses"| VS
    S -->|"uses"| SP
    S -->|"uses"| VZ
    S -->|"calls"| GF
    S -->|"manages"| PWA

    click S "https://github.com/junian/markdown-resume/tree/master/site/"
    click CC "https://github.com/junian/markdown-resume/tree/master/packages/correct-case"
    click DC "https://github.com/junian/markdown-resume/tree/master/packages/dynamic-css"
    click CR "https://github.com/junian/markdown-resume/tree/master/packages/markdown-it-cross-ref"
    click KT "https://github.com/junian/markdown-resume/tree/master/packages/markdown-it-katex"
    click LC "https://github.com/junian/markdown-resume/tree/master/packages/markdown-it-latex-cmds"
    click GF "https://github.com/junian/markdown-resume/tree/master/packages/gfonts-loader"
    click VS "https://github.com/junian/markdown-resume/tree/master/packages/vue-shortcuts"
    click SP "https://github.com/junian/markdown-resume/tree/master/packages/vue-smart-pages"
    click VZ "https://github.com/junian/markdown-resume/tree/master/packages/vue-zoom"

    classDef frontend fill:#f8c471,stroke:#9c640c,stroke-width:2px;
    classDef package fill:#aed6f1,stroke:#2471a3,stroke-width:2px;
    classDef external fill:#a3e4d7,stroke:#1abc9c,stroke-width:2px;
    classDef client fill:#fad7a0,stroke:#e67e22,stroke-width:2px;
```
