# aslam97/minimal-tiptap architecture

> Architecture diagram of the GitHub repository aslam97/minimal-tiptap, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aslam97/minimal-tiptap
- Repository: https://github.com/aslam97/minimal-tiptap

## Overview

##### Project Type and Purpose
- This is a “component library” full-stack project, but focused entirely on the frontend.
- It packages a customizable rich-text editor built on Tiptap and Shadcn UI, then publishes a block-registry JSON for shadcn/ui integration.

##### File Structure Analysis
Top-level artifacts:
- src/
– components/minimal-tiptap: the core editor module (extensions, hooks, styles, UI wrappers)
– components/ui: Shadcn UI wrapper components (button, dialog, tooltip, etc.)
– components/custom: example usage patterns (hero, grid, forms)
– lib/utils.ts, data/content.json
– main.tsx, App.tsx (demo harness)
- public/: static assets and manifest
- registry/block-registry.json: published registry manifest
- scripts/: build.ts (generates registry), schema.ts
- Vite & TypeScript configs, package.json

##### Key README Insights
- It’s installed via shadcn CLI or manually added.
- Exposes a `<MinimalTiptapEditor>` React component with props for value, onChange, toolbar configuration, image handling, etc.
- Image support is pluggable (uploadFn, validation, error handlers).
- Development workflow: run `build-registry` → host/serve registry → shadcn CLI consumes registry.

##### Main Components
A. Consumer Application
– Your React app that consumes the registry or imports `minimal-tiptap` directly.
B. shadcn CLI & Registry
– CLI (npx shadcn@latest) pulls block-registry.json
– registry/block-registry.json describes metadata & entry points
C. Minimal Tiptap Editor Package
1. Editor Core (Tiptap Starter Kit + custom extensions)
2. UI Layer (Shadcn UI wrappers, Tailwind CSS)
3. Hooks & Utils (useMinimalTiptap, useTheme, useThrottle, utils.ts)
4. Styles (CSS partials under minimal-tiptap/styles)
D. Build & Publish Pipeline
– scripts/build.ts and schema.ts generate registry manifest
– CI/Local host registry via `npm run host-registry`
E. Runtime Dependencies

##### Component Interactions
1. Consumer App → (via shadcn CLI or direct import) → registry/block-registry.json → pulls Editor Package
2. Consumer mounts `<MinimalTiptapEditor>` inside `<TooltipProvider>`
4. UI Layer renders toolbar sections (SectionOne, Two, Four, Five) and content area
5. User actions → Tiptap Transactions → onChange prop → consumer state
6. Image uploads: Editor calls uploadFn → custom uploader → returns URL → Tiptap mounts image node
7. Build scripts scan src/components/minimal-tiptap to generate block-registry.json for CLI

##### Architectural Patterns & Principles
- Component-Based Design: decoupled React components (core editor vs. UI vs. examples).
- Registry Pattern: external JSON manifest decouples publishing from code.
- Build Pipeline: scripts generate metadata for CLI consumers.

##### Technologies & Frameworks
– React + TypeScript + Vite
– Tiptap (ProseMirror)
– Shadcn UI (Radix UI + Tailwind CSS)
– Node scripts (TypeScript) for registry build

##### Diagramming Recommendations
– Orange for CLI & registry artifacts.
- Essential props/data flows: “value → onChange → output format (HTML/JSON/text)”, “uploadFn → HTTP request → image URL”.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Consumer Application"
        CMain["src/main.tsx"]:::code
        CApp["src/App.tsx"]:::code
        CIndex["index.html"]:::code
    end

    subgraph "Registry & CLI"
        Build["scripts/build.ts"]:::cli
        Schema["scripts/schema.ts"]:::cli
        Registry["registry/block-registry.json"]:::cli
        CLI["shadcn CLI"]:::cli
    end

    subgraph "Minimal Tiptap Editor Package"
        subgraph "Editor Core"
            CoreIndex["index.ts"]:::code
            CoreComponent["minimal-tiptap.tsx"]:::code
        end
        subgraph "UI Layer"
            UIComps["components/..."]:::code
            UIShadcn["components/ui/..."]:::code
        end
        subgraph "Hooks & Utils"
            Hook1["use-minimal-tiptap.ts"]:::code
            Hook2["use-theme.ts"]:::code
            Hook3["use-throttle.ts"]:::code
            Hook4["use-container-size.ts"]:::code
            Utils["utils.ts"]:::code
        end
        subgraph "Styles"
            StylesIndex["index.css"]:::code
            StylesPartials["partials/..."]:::code
        end
        subgraph "Extensions"
            ExtIndex["index.ts"]:::code
            ExtCB["code-block-lowlight/"]:::code
            ExtColor["color/"]:::code
            ExtImage["image/"]:::code
            ExtHR["horizontal-rule/"]:::code
            ExtResetEnter["reset-marks-on-enter/"]:::code
            ExtUnsetAll["unset-all-marks/"]:::code
        end
    end

    subgraph "Runtime Dependencies"
        Tiptap["@tiptap/react"]:::external
        ExtensionsDeps["@tiptap/extensions"]:::external
        Lowlight["lowlight"]:::external
        Zoom["react-medium-image-zoom"]:::external
        RadixIcons["@radix-ui/react-icons"]:::external
        Tailwind["tailwindcss"]:::external
    end

    Build -->|generates| Registry
    Schema -->|defines schema| Registry
    Registry -->|consumed by| CLI
    CLI -->|publishes| CoreIndex
    CMain -->|imports package| CoreIndex
    CApp -->|mounts component| CoreComponent
    CMain -->|pulls registry| Registry
    CoreComponent -->|uses hook| Hook1
    CoreComponent -->|initializes| Tiptap
    UIComps -->|wraps UI| UIShadcn
    Hook1 -->|calls util| Utils
    CoreComponent -->|applies styles| StylesIndex
    CoreComponent -->|loads extensions| ExtIndex

    classDef code fill:#cce5ff,stroke:#0056b3,stroke-width:1px
    classDef cli fill:#ffe5b4,stroke:#cc8400,stroke-width:1px
    classDef external fill:#d4f4dd,stroke:#228B22,stroke-width:1px

    click CMain "https://github.com/aslam97/minimal-tiptap/blob/main/src/main.tsx"
    click CApp "https://github.com/aslam97/minimal-tiptap/blob/main/src/App.tsx"
    click CIndex "https://github.com/aslam97/minimal-tiptap/blob/main/index.html"
    click Build "https://github.com/aslam97/minimal-tiptap/blob/main/scripts/build.ts"
    click Schema "https://github.com/aslam97/minimal-tiptap/blob/main/scripts/schema.ts"
    click Registry "https://github.com/aslam97/minimal-tiptap/blob/main/registry/block-registry.json"
    click CoreIndex "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/index.ts"
    click CoreComponent "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/minimal-tiptap.tsx"
    click UIComps "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/components/"
    click UIShadcn "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/ui/"
    click Hook1 "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/hooks/use-minimal-tiptap.ts"
    click Hook2 "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/hooks/use-theme.ts"
    click Hook3 "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/hooks/use-throttle.ts"
    click Hook4 "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/hooks/use-container-size.ts"
    click Utils "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/utils.ts"
    click StylesIndex "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/styles/index.css"
    click StylesPartials "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/styles/partials/"
    click ExtIndex "https://github.com/aslam97/minimal-tiptap/blob/main/src/components/minimal-tiptap/extensions/index.ts"
    click ExtCB "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/extensions/code-block-lowlight/"
    click ExtColor "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/extensions/color/"
    click ExtImage "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/extensions/image/"
    click ExtHR "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/extensions/horizontal-rule/"
    click ExtResetEnter "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/extensions/reset-marks-on-enter/"
    click ExtUnsetAll "https://github.com/aslam97/minimal-tiptap/tree/main/src/components/minimal-tiptap/extensions/unset-all-marks/"
```
