# evanusmodestus/obsidian-asciidoc-viewer architecture

> Architecture diagram of the GitHub repository evanusmodestus/obsidian-asciidoc-viewer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/evanusmodestus/obsidian-asciidoc-viewer
- Repository: https://github.com/evanusmodestus/obsidian-asciidoc-viewer

## Overview

Obsidian users open native AsciiDoc files in the plugin’s edit/read view; preview renders source into sanitized HTML and optionally renders Mermaid or PlantUML diagrams. Plugin settings control rendering, security, and display features. The README documents syntax highlighting, math, tables of contents, themes, and restrictive safe modes; these are options within rendering/settings rather than separate pipeline stages. Relationships reflect the sampled source and README; unsampled implementation details are not inferred.

Main entry points: [`src/renderer/AsciidocRenderer.ts`](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/AsciidocRenderer.ts) (AsciiDoc Renderer), [`src/AsciidocPlugin.ts`](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/AsciidocPlugin.ts) (Plugin Lifecycle), [`src/renderer/DiagramProcessor.ts`](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/DiagramProcessor.ts) (Diagram Processor), [`src/security/SecurityConfig.ts`](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/security/SecurityConfig.ts) (Security Configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["Obsidian Integration"]
  node_obsidian["Obsidian"]
  node_plugin["Plugin Lifecycle<br/>[AsciidocPlugin.ts]"]
end

subgraph group_documents["Document Experience"]
  node_view["Edit / Read View<br/>[AsciidocView.ts]"]
end

subgraph group_rendering["Rendering and Diagrams"]
  node_renderer["AsciiDoc Renderer"]
  node_asciidoctor["Asciidoctor.js"]
  node_sanitizer["HTML Sanitizer"]
  node_diagrams["Diagram Processor"]
  node_mermaid["Mermaid Converter"]
  node_plantuml["PlantUML Converter"]
end

subgraph group_configuration["Settings and Security"]
  node_settings["Settings Defaults"]
  node_settings_ui["Settings UI<br/>[SettingsTab.ts]"]
  node_security["Security Configuration<br/>[SecurityConfig.ts]"]
end

node_user(("Obsidian User"))
node_kroki["Self-hosted Kroki"]

node_user -->|"opens files"| node_obsidian
node_obsidian -->|"loads plugin"| node_plugin
node_plugin -->|"registers view"| node_view
node_plugin -->|"registers tab"| node_settings_ui
node_plugin -->|"loads defaults"| node_settings
node_settings_ui -->|"saves settings"| node_plugin
node_settings_ui -->|"assesses security"| node_security
node_view -->|"renders preview"| node_renderer
node_renderer -->|"converts source"| node_asciidoctor
node_renderer -->|"gets options"| node_security
node_renderer -->|"sanitizes HTML"| node_sanitizer
node_renderer -->|"processes diagrams"| node_diagrams
node_sanitizer -->|"checks URLs"| node_security
node_diagrams -->|"renders Mermaid"| node_mermaid
node_diagrams -->|"renders PlantUML"| node_plantuml
node_diagrams -->|"sanitizes SVG"| node_sanitizer
node_plantuml -->|"validates server"| node_security
node_plantuml -->|"posts diagram"| node_kroki

click node_plugin "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/AsciidocPlugin.ts"
click node_settings "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/settings/SettingsInterface.ts"
click node_settings_ui "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/settings/SettingsTab.ts"
click node_view "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/views/AsciidocView.ts"
click node_renderer "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/AsciidocRenderer.ts"
click node_security "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/security/SecurityConfig.ts"
click node_sanitizer "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/SanitizationLayer.ts"
click node_diagrams "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/DiagramProcessor.ts"
click node_mermaid "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/converters/MermaidConverter.ts"
click node_plantuml "https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/converters/PlantUMLConverter.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_obsidian,node_plugin,node_user toneBlue
class node_view toneAmber
class node_renderer,node_asciidoctor,node_sanitizer,node_diagrams,node_mermaid,node_plantuml toneMint
class node_settings,node_settings_ui,node_security toneRose
class node_kroki toneIndigo
```

## Components

### Obsidian Integration

- **Obsidian**
- [Plugin Lifecycle](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/AsciidocPlugin.ts): `src/AsciidocPlugin.ts`

### Document Experience

- [Edit / Read View](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/views/AsciidocView.ts): `src/views/AsciidocView.ts`

### Rendering and Diagrams

- [AsciiDoc Renderer](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/AsciidocRenderer.ts): `src/renderer/AsciidocRenderer.ts`
- **Asciidoctor.js**
- [HTML Sanitizer](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/SanitizationLayer.ts): `src/renderer/SanitizationLayer.ts`
- [Diagram Processor](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/renderer/DiagramProcessor.ts): `src/renderer/DiagramProcessor.ts`
- [Mermaid Converter](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/converters/MermaidConverter.ts): `src/converters/MermaidConverter.ts`
- [PlantUML Converter](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/converters/PlantUMLConverter.ts): `src/converters/PlantUMLConverter.ts`

### Settings and Security

- [Settings Defaults](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/settings/SettingsInterface.ts): `src/settings/SettingsInterface.ts`
- [Settings UI](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/settings/SettingsTab.ts): `src/settings/SettingsTab.ts`
- [Security Configuration](https://github.com/evanusmodestus/obsidian-asciidoc-viewer/blob/main/src/security/SecurityConfig.ts): `src/security/SecurityConfig.ts`

### Other components

- **Obsidian User**
- **Self-hosted Kroki**

## Connections

- Obsidian User → Obsidian: opens files (evidence: `README.md`)
- Obsidian → Plugin Lifecycle: loads plugin
- Plugin Lifecycle → Edit / Read View: registers view (evidence: `src/AsciidocPlugin.ts`)
- Plugin Lifecycle → Settings UI: registers tab (evidence: `src/AsciidocPlugin.ts`)
- Plugin Lifecycle → Settings Defaults: loads defaults (evidence: `src/AsciidocPlugin.ts`)
- Settings UI → Plugin Lifecycle: saves settings (evidence: `src/settings/SettingsTab.ts`)
- Settings UI → Security Configuration: assesses security (evidence: `src/settings/SettingsTab.ts`)
- Edit / Read View → AsciiDoc Renderer: renders preview (evidence: `src/views/AsciidocView.ts`)
- AsciiDoc Renderer → Asciidoctor.js: converts source (evidence: `src/renderer/AsciidocRenderer.ts`)
- AsciiDoc Renderer → Security Configuration: gets options (evidence: `src/renderer/AsciidocRenderer.ts`)
- AsciiDoc Renderer → HTML Sanitizer: sanitizes HTML (evidence: `src/renderer/AsciidocRenderer.ts`)
- AsciiDoc Renderer → Diagram Processor: processes diagrams (evidence: `src/renderer/AsciidocRenderer.ts`)
- HTML Sanitizer → Security Configuration: checks URLs (evidence: `src/renderer/SanitizationLayer.ts`)
- Diagram Processor → Mermaid Converter: renders Mermaid (evidence: `src/renderer/DiagramProcessor.ts`)
- Diagram Processor → PlantUML Converter: renders PlantUML (evidence: `src/renderer/DiagramProcessor.ts`)
- Diagram Processor → HTML Sanitizer: sanitizes SVG (evidence: `src/renderer/DiagramProcessor.ts`)
- PlantUML Converter → Security Configuration: validates server (evidence: `src/converters/PlantUMLConverter.ts`)
- PlantUML Converter → Self-hosted Kroki: posts diagram (evidence: `src/converters/PlantUMLConverter.ts`)
