# obsidianmd/obsidian-sample-plugin architecture

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

- Interactive diagram: https://gitdiagram.com/obsidianmd/obsidian-sample-plugin
- Repository: https://github.com/obsidianmd/obsidian-sample-plugin

## Overview

##### Project type and purpose
- This is a sample Obsidian plugin project written in TypeScript.

##### File structure
- Everything lives at the repo root—no separate `src` or `lib` directories.
- main.ts           – the plugin’s entrypoint and core logic
- manifest.json     – plugin metadata (ID, version, minAppVersion)
- styles.css        – any CSS the plugin injects
- esbuild.config.mjs, tsconfig.json – build configuration
- package.json      – npm metadata and scripts
- version-bump.mjs, versions.json – release/versioning support
- Config files (.eslintrc, .editorconfig, etc.) support linting and formatting.

##### Key insights from README
- Walks through build & dev workflow (`npm run dev` → compile `main.ts` → `main.js`).
- Covers release steps and version management.

- Host App (e.g., gray)
- Plugin runtime (e.g., blue)
- Developer/build tooling (e.g., green)
- Packages (rectangles)
- External APIs (rounded rectangles)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Host Application Layer
    subgraph "Host Application"
        O["Obsidian Core"]:::host
        PL["Plugin Loader"]:::host
    end

    %% External API Definitions
    API["obsidian.d.ts"]:::external

    %% Plugin Package
    subgraph "Sample Plugin Package"
        MP["manifest.json"]:::plugin
        MT["main.ts"]:::plugin
        SC["styles.css"]:::plugin
        subgraph "Plugin Runtime Features"
            RIB["Ribbon Icon Handler"]:::plugin
            CMD["Command: Open Sample Modal"]:::plugin
            MOD["Modal Window"]:::plugin
            SET["Settings UI"]:::plugin
            EV["Global Event Handler"]:::plugin
            INT["Interval Logger"]:::plugin
        end
    end

    %% Developer Toolchain
    subgraph "Developer Toolchain"
        NPM["Node.js / npm"]:::dev
        ESB["esbuild.config.mjs"]:::dev
        TS["tsconfig.json"]:::dev
        PKG["package.json"]:::dev
        VBS["version-bump.mjs"]:::dev
        VRS["versions.json"]:::dev
        RMD["README.md"]:::dev
        ESLRC[".eslintrc"]:::dev
        ESLIG[".eslintignore"]:::dev
        EDCFG[".editorconfig"]:::dev
    end

    %% Relationships
    O -->|"discovers/plugins"| PL
    PL -->|"load() lifecycle"| MT
    PL --> MP
    PL --> SC
    MT --> RIB
    MT --> CMD
    CMD --> MOD
    SET -->|"reads/writes"| MT
    EV -->|"listens to"| API
    INT -->|"calls"| API

    API -.->|API Definitions| MT

    %% Build Pipeline
    ESB -->|"bundle"| SC
    ESB -->|"bundle"| MT
    TS -->|"compile"| MT
    PKG -->|"scripts"| NPM
    NPM -->|"runs"| ESB
    NPM -->|"runs"| TS
    VBS -->|"updates"| VRS
    RMD -->|"docs for"| MT

    %% Styles
    classDef host fill:#d3d3d3,stroke:#333,stroke-width:1px;
    classDef plugin fill:#add8e6,stroke:#333,stroke-width:1px;
    classDef dev fill:#90ee90,stroke:#333,stroke-width:1px;
    classDef external fill:#f4a460,stroke:#333,stroke-width:1px;

    %% Click Events
    click MP "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/manifest.json"
    click MT "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/main.ts"
    click SC "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/styles.css"
    click ESB "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/esbuild.config.mjs"
    click TS "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/tsconfig.json"
    click PKG "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/package.json"
    click VBS "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/version-bump.mjs"
    click VRS "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/versions.json"
    click RMD "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/README.md"
    click ESLRC "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/.eslintrc"
    click ESLIG "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/.eslintignore"
    click EDCFG "https://github.com/obsidianmd/obsidian-sample-plugin/blob/master/.editorconfig"
```
