# superlistapp/super_editor architecture

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

- Interactive diagram: https://gitdiagram.com/superlistapp/super_editor
- Repository: https://github.com/superlistapp/super_editor

## Overview

##### Project type and purpose
- This is a Flutter/Dart “mono‐repo” toolkit, not a single app or service.
- It delivers a configurable, extensible text‐editing framework (“Super Editor”) plus supporting packages (layout, markdown, clipboard, quill integration, spellcheck, keyboard plugins).
- It also includes sample apps (in super_clones and several example folders), documentation sites (in doc and website), and testing utilities (golden_runner, flutter_test_registry).

##### File structure
- Top‐level packages each in its own folder with a pubspec.yaml:
- attributed_text
- super_text_layout
- super_editor (core editor)
- super_editor_markdown
- super_editor_quill
- super_editor_clipboard
- super_editor_spellcheck
- super_keyboard
- super_clones (multiple “clone” demo apps)
- golden_runner, flutter_test_registry (test orchestration)
- doc/website, website (documentation sites)
- Each package has lib/src (implementation), test (unit/integration tests), example (demo Flutter apps), platform folders (android/ios/web/linux/macos/windows) for cross‐platform builds.
- CI/CD manifests in .github/workflows trigger builds, tests, doc site deployments.

##### README for additional insights
- Emphasizes mono‐repo versioning: cross‐dependency on latest versions of all packages.
- Mentions documentation website built with Flutter and static site generator (Jinja templates under doc/website).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CI/CD Layer
    Dev["Developer / CI"]:::ci
    CI["GitHub Actions"]:::ci
    Dev -->|"triggers"| CI
    click Dev "https://github.com/superlistapp/super_editor/tree/main/.github/workflows"
    click CI "https://github.com/superlistapp/super_editor/blob/main/.github/workflows/*.yaml"

    %% Repository Root
    Repo["Mono-repo (Root)"]:::repo
    CI -->|"clones & orchestrates"| Repo
    click Repo "https://github.com/superlistapp/super_editor/blob/main/."

    %% Core Libraries
    subgraph "Core Libraries"
        direction TB
        AT["Attributed Text"]:::core
        STL["Super Text Layout"]:::core
        SE["Super Editor"]:::core
        AT -->|"layout depends on"| STL
        STL -->|"editor depends on"| SE
        click AT "https://github.com/superlistapp/super_editor/tree/main/attributed_text/"
        click STL "https://github.com/superlistapp/super_editor/tree/main/super_text_layout/"
        click SE "https://github.com/superlistapp/super_editor/tree/main/super_editor/"
        %% Submodules of Super Editor
        subgraph "Super Editor Modules"
            direction TB
            DE["default_editor"]:::core
            SR["super_reader"]:::core
            TF["super_textfield"]:::core
            click DE "https://github.com/superlistapp/super_editor/tree/main/super_editor/lib/src/default_editor/"
            click SR "https://github.com/superlistapp/super_editor/tree/main/super_editor/lib/src/super_reader/"
            click TF "https://github.com/superlistapp/super_editor/tree/main/super_editor/lib/src/super_textfield/"
        end
        SE --> DE
        SE --> SR
        SE --> TF
    end

    %% Extension Libraries
    subgraph "Extension Libraries"
        direction TB
        MD["Markdown Serializer"]:::ext
        QI["Quill Delta Integration"]:::ext
        CIp["Clipboard Integration"]:::ext
        SP["Spellcheck Plugin"]:::ext
        KB["Keyboard Plugin"]:::ext
        click MD "https://github.com/superlistapp/super_editor/tree/main/super_editor_markdown/"
        click QI "https://github.com/superlistapp/super_editor/tree/main/super_editor_quill/"
        click CIp "https://github.com/superlistapp/super_editor/tree/main/super_editor_clipboard/"
        click SP "https://github.com/superlistapp/super_editor/tree/main/super_editor_spellcheck/"
        click KB "https://github.com/superlistapp/super_editor/tree/main/super_keyboard/"
        %% Dependencies
        MD -->|"extends"| SE
        QI -->|"extends"| SE
        CIp -->|"extends"| SE
        SP -->|"extends"| SE
        KB -->|"extends"| SE
    end

    %% Demo Applications
    subgraph "Demo Applications"
        direction TB
        SC["Super Clones"]:::demo
        SEex["Editor Examples"]:::demo
        SPex["Spellcheck Example"]:::demo
        STex["Text Layout Example"]:::demo
        KBex["Keyboard Example"]:::demo
        click SC "https://github.com/superlistapp/super_editor/tree/main/super_clones/"
        click SEex "https://github.com/superlistapp/super_editor/tree/main/super_editor/example/"
        click SPex "https://github.com/superlistapp/super_editor/tree/main/super_editor_spellcheck/example/"
        click STex "https://github.com/superlistapp/super_editor/tree/main/super_text_layout/example/"
        click KBex "https://github.com/superlistapp/super_editor/tree/main/super_keyboard/example/"
        %% Usage
        SC -->|"imports Core & Extensions"| AT
        SEex --> AT
        SEex --> MD
        SPex --> SP
        STex --> STL
        KBex --> KB
    end

    %% Testing Utilities
    subgraph "Testing Utilities"
        direction TB
        GR["Golden Runner"]:::test
        FTR["Flutter Test Registry"]:::test
        click GR "https://github.com/superlistapp/super_editor/tree/main/golden_runner/"
        click FTR "https://github.com/superlistapp/super_editor/tree/main/flutter_test_registry/"
        CI -->|"runs tests"| GR
        CI -->|"runs tests"| FTR
    end

    %% Documentation Sites
    subgraph "Documentation Sites"
        direction TB
        JJ["Jinja-based Docs"]:::docs
        FL["Flutter-based Site"]:::docs
        click JJ "https://github.com/superlistapp/super_editor/tree/main/doc/website/"
        click FL "https://github.com/superlistapp/super_editor/tree/main/website/"
        CI -->|"deploys docs"| JJ
        CI -->|"deploys docs"| FL
    end

    %% Class Definitions
    classDef ci fill:#FFE082,stroke:#F9A825,color:#000;
    classDef repo fill:#B3E5FC,stroke:#0288D1,color:#000;
    classDef core fill:#C8E6C9,stroke:#388E3C,color:#000;
    classDef ext fill:#FFCCBC,stroke:#E64A19,color:#000;
    classDef demo fill:#D1C4E9,stroke:#512DA8,color:#000;
    classDef test fill:#FFCDD2,stroke:#C62828,color:#000;
    classDef docs fill:#B2DFDB,stroke:#00796B,color:#000;
```
