How evanusmodestus/obsidian-asciidoc-viewer works
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: AsciidocRenderer.ts AsciiDoc Renderer · AsciidocPlugin.ts Plugin Lifecycle · DiagramProcessor.ts Diagram Processor · SecurityConfig.ts Security Configuration
Components 14
Obsidian Integration
- Obsidian
- Plugin Lifecycle
src/AsciidocPlugin.ts
Document Experience
- Edit / Read View
src/views/AsciidocView.ts
Rendering and Diagrams
- AsciiDoc Renderer
src/renderer/AsciidocRenderer.ts - Asciidoctor.js
- HTML Sanitizer
src/renderer/SanitizationLayer.ts - Diagram Processor
src/renderer/DiagramProcessor.ts - Mermaid Converter
src/converters/MermaidConverter.ts - PlantUML Converter
src/converters/PlantUMLConverter.ts
Settings and Security
- Settings Defaults
src/settings/SettingsInterface.ts - Settings UI
src/settings/SettingsTab.ts - Security Configuration
src/security/SecurityConfig.ts
Other components
- Obsidian User
- Self-hosted Kroki
Connections 18
- Obsidian User → Obsidian: opens files
README.md - Obsidian → Plugin Lifecycle: loads plugin
- Plugin Lifecycle → Edit / Read View: registers view
src/AsciidocPlugin.ts - Plugin Lifecycle → Settings UI: registers tab
src/AsciidocPlugin.ts - Plugin Lifecycle → Settings Defaults: loads defaults
src/AsciidocPlugin.ts - Settings UI → Plugin Lifecycle: saves settings
src/settings/SettingsTab.ts - Settings UI → Security Configuration: assesses security
src/settings/SettingsTab.ts - Edit / Read View → AsciiDoc Renderer: renders preview
src/views/AsciidocView.ts - AsciiDoc Renderer → Asciidoctor.js: converts source
src/renderer/AsciidocRenderer.ts - AsciiDoc Renderer → Security Configuration: gets options
src/renderer/AsciidocRenderer.ts - AsciiDoc Renderer → HTML Sanitizer: sanitizes HTML
src/renderer/AsciidocRenderer.ts - AsciiDoc Renderer → Diagram Processor: processes diagrams
src/renderer/AsciidocRenderer.ts - HTML Sanitizer → Security Configuration: checks URLs
src/renderer/SanitizationLayer.ts - Diagram Processor → Mermaid Converter: renders Mermaid
src/renderer/DiagramProcessor.ts - Diagram Processor → PlantUML Converter: renders PlantUML
src/renderer/DiagramProcessor.ts - Diagram Processor → HTML Sanitizer: sanitizes SVG
src/renderer/DiagramProcessor.ts - PlantUML Converter → Security Configuration: validates server
src/converters/PlantUMLConverter.ts - PlantUML Converter → Self-hosted Kroki: posts diagram
src/converters/PlantUMLConverter.ts