# obsidianmd/obsidian-clipper architecture

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

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

## Overview

##### Connection Flow

- User Interface → Content Scripts → Background Service
- Background Service → Content Extraction → Template Processing → Markdown Conversion → Obsidian Integration

##### Component Details

For each major component, include:
- Input/Output specifications
- Key dependencies (third-party libraries)
- Cross-component interactions

**Content Extraction System**

**Input: Web page DOM**
**Output: Structured content**
**Dependencies:**
- Readability
- DOMPurify
**Connected to:**
- Template Engine
- Markdown Converter

##### Technical Stack Indicators

Technology badges for:
- TypeScript
- WebExtension APIs
- Third-party libraries (Readability, Turndown, etc.)

##### Cross-Platform Support

- Manifest variations (manifest.chrome.json, manifest.firefox.json, manifest.safari.json)
- Platform-specific implementations

##### Data Flow Patterns

Data transformation flows:
##### Settings → Storage → Feature Configuration

Remember to:
- Clear boundaries between different functional areas
- Security boundaries and data sanitization points

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and classes
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef processing fill:#2ecc71,stroke:#27ae60,color:white
    classDef integration fill:#f1c40f,stroke:#f39c12,color:black
    classDef feature fill:#9b59b6,stroke:#8e44ad,color:white
    classDef utility fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Browser Extension Layer
    subgraph BrowserLayer["Browser Extension Layer"]
        PopupUI["Popup Interface"]:::ui
        Settings["Settings Panel"]:::ui
        Content["Content Scripts"]:::ui
        Background["Background Service"]:::ui
    end

    %% Core Processing Layer
    subgraph CoreLayer["Core Processing Layer"]
        ContentExtractor["Content Extraction System"]:::processing
        TemplateEngine["Template Engine"]:::processing
        MarkdownConverter["Markdown Conversion"]:::processing
        Highlighter["Highlighting System"]:::processing
    end

    %% Feature Modules Layer
    subgraph FeatureLayer["Feature Modules Layer"]
        Filters["Filters System"]:::feature
        Variables["Variables System"]:::feature
        SiteExtractors["Site-specific Extractors"]:::feature
    end

    %% Integration Layer
    subgraph IntegrationLayer["Integration Layer"]
        ObsidianIntegration["Obsidian Integration"]:::integration
        BrowserAPI["Browser API Integration"]:::integration
        Storage["Storage Management"]:::utility
        I18n["Internationalization"]:::utility
    end

    %% Cross-Platform Support
    subgraph PlatformSupport["Multi-browser Support"]
        Chrome["Chrome Manifest"]:::integration
        Firefox["Firefox Manifest"]:::integration
        Safari["Safari Manifest"]:::integration
    end

    %% Connections
    PopupUI --> Content
    Settings --> Background
    Content --> Background
    Background --> ContentExtractor
    ContentExtractor --> TemplateEngine
    TemplateEngine --> MarkdownConverter
    MarkdownConverter --> ObsidianIntegration
    Content --> Highlighter
    Highlighter --> Storage
    
    ContentExtractor --> Filters
    ContentExtractor --> Variables
    ContentExtractor --> SiteExtractors
    
    Background --> BrowserAPI
    Background --> Storage
    Background --> I18n

    %% Click events for component mapping
    click PopupUI "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/core/popup.ts"
    click Settings "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/core/settings.ts"
    click Content "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/content.ts"
    click Background "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/background.ts"
    click ContentExtractor "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/content-extractor.ts"
    click TemplateEngine "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/template-compiler.ts"
    click MarkdownConverter "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/markdown-converter.ts"
    click Highlighter "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/highlighter.ts"
    click Filters "https://github.com/obsidianmd/obsidian-clipper/tree/main/src/utils/filters/"
    click Variables "https://github.com/obsidianmd/obsidian-clipper/tree/main/src/utils/variables/"
    click SiteExtractors "https://github.com/obsidianmd/obsidian-clipper/tree/main/src/utils/extractors/"
    click ObsidianIntegration "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/obsidian-note-creator.ts"
    click BrowserAPI "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/browser-polyfill.ts"
    click I18n "https://github.com/obsidianmd/obsidian-clipper/tree/main/src/locales/"
    click Storage "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/utils/storage-utils.ts"
    click Chrome "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/manifest.chrome.json"
    click Firefox "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/manifest.firefox.json"
    click Safari "https://github.com/obsidianmd/obsidian-clipper/blob/main/src/manifest.safari.json"

    %% Legend
    subgraph Legend
        UI["UI Components"]:::ui
        Proc["Processing Components"]:::processing
        Int["Integration Points"]:::integration
        Feat["Feature Modules"]:::feature
        Util["Utility Services"]:::utility
    end
```
