# obsidian-community/web-clipper-templates architecture

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

- Interactive diagram: https://gitdiagram.com/obsidian-community/web-clipper-templates
- Repository: https://github.com/obsidian-community/web-clipper-templates

## Overview

##### Project Type Analysis
This is a template repository project that serves as a community collection of web clipper templates for the Obsidian Web Clipper browser extension. The project is primarily focused on configuration and documentation.

##### Main Components

A. Template Collection System
- Template Storage (JSON files)
- Documentation (Markdown files)
- Resource Guides
- Meta Information

B. Integration Points
- Obsidian Web Clipper Extension
- Various Web Services (YouTube, GitHub, Reddit, etc.)
- Obsidian Application

- YouTube
- GitHub
- Reddit
- Apple Podcasts
- Gmail
- Indeed
- The Hacker News

- Template Definitions (JSON)
- CSS Selectors
- Data Transformation Rules

- Obsidian Application
- Note Storage

##### Key Elements to Highlight

- Social Media Templates (Reddit, YouTube)
- Development Templates (GitHub)
- Communication Templates (Gmail)
- Job Search Templates (Indeed)
- News Templates (Hacker News)

b) Documentation Structure:
- Template Guides
- Resource Guides
- Meta Information
- Clipper Guides

Use the following symbols and conventions:
- Rounded rectangles for documentation components
- Blue: Source systems
- Green: Template definitions
- Orange: Documentation
- Purple: Target system (Obsidian)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Style Definitions
    classDef sourceSystem fill:#a8d1f0,stroke:#333
    classDef template fill:#90EE90,stroke:#333
    classDef documentation fill:#FFB366,stroke:#333
    classDef target fill:#DDA0DD,stroke:#333
    classDef guide fill:#FFE4B5,stroke:#333

    %% Source Systems Layer
    subgraph Sources
        YT["YouTube"]:::sourceSystem
        GH["GitHub"]:::sourceSystem
        RD["Reddit"]:::sourceSystem
        AP["Apple Podcasts"]:::sourceSystem
        GM["Gmail"]:::sourceSystem
        IN["Indeed"]:::sourceSystem
        HN["The Hacker News"]:::sourceSystem
    end

    %% Template Processing Layer
    subgraph Templates
        YT_T["YouTube Templates"]:::template
        GH_T["GitHub Templates"]:::template
        RD_T["Reddit Template"]:::template
        AP_T["Apple Podcasts Template"]:::template
        GM_T["Gmail Template"]:::template
        IN_T["Indeed Template"]:::template
        HN_T["Hacker News Template"]:::template
    end

    %% Documentation Layer
    subgraph Docs
        TG["Template Guides"]:::documentation
        CG["Clipper Guides"]:::documentation
        RG["Resource Guides"]:::documentation
        MI["Meta Information"]:::documentation
    end

    %% Target System
    OBS["Obsidian Application"]:::target

    %% Relationships
    YT --> YT_T
    GH --> GH_T
    RD --> RD_T
    AP --> AP_T
    GM --> GM_T
    IN --> IN_T
    HN --> HN_T

    YT_T --> OBS
    GH_T --> OBS
    RD_T --> OBS
    AP_T --> OBS
    GM_T --> OBS
    IN_T --> OBS
    HN_T --> OBS

    TG -.-> YT_T
    TG -.-> GH_T
    TG -.-> RD_T
    CG -.-> OBS
    RG -.-> Templates
    MI -.-> Templates

    %% Click Events
    click YT_T "https://github.com/obsidian-community/web-clipper-templates/tree/main/templates/"
    click GH_T "https://github.com/obsidian-community/web-clipper-templates/tree/main/templates/"
    click RD_T "https://github.com/obsidian-community/web-clipper-templates/blob/main/templates/reddit-post-clipper.json"
    click AP_T "https://github.com/obsidian-community/web-clipper-templates/blob/main/templates/apple-podcast-episode-clipper.json"
    click GM_T "https://github.com/obsidian-community/web-clipper-templates/blob/main/templates/google-mail-clipper.json"
    click IN_T "https://github.com/obsidian-community/web-clipper-templates/blob/main/templates/indeed-job-applications.json"
    click HN_T "https://github.com/obsidian-community/web-clipper-templates/blob/main/templates/the-hacker-news-clipper.json"
    click TG "https://github.com/obsidian-community/web-clipper-templates/tree/main/Template-guides/"
    click CG "https://github.com/obsidian-community/web-clipper-templates/tree/main/Clipper-guides/"
    click RG "https://github.com/obsidian-community/web-clipper-templates/tree/main/Resources/"
    click MI "https://github.com/obsidian-community/web-clipper-templates/tree/main/Meta/"

    %% Legend
    subgraph Legend
        L1["Source System"]:::sourceSystem
        L2["Template"]:::template
        L3["Documentation"]:::documentation
        L4["Target System"]:::target
        L5[" Direct Flow"] --> L6[" "]
        L7[" Optional Flow"] -.-> L8[" "]
    end
```
