# obsidianmd/obsidian-help architecture

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

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

## Overview

Obsidian Help is a multilingual documentation project: contributors maintain English source content and translated standalone vaults, which are published as language-specific sites. The README documents scripts as the mechanism for copying and applying English changes to translations, and says commits to main trigger publication. The sampled publish code implements an in-page language switcher; most locale content and scripts were not excerpted, so their internal details and finer-grained calls are not shown.

Main entry points: [`en`](https://github.com/obsidianmd/obsidian-help/tree/master/en) (English source docs), [`ar`](https://github.com/obsidianmd/obsidian-help/tree/master/ar) (Translated docs), [`scripts`](https://github.com/obsidianmd/obsidian-help/tree/master/scripts) (Translation scripts), [`km/publish.js`](https://github.com/obsidianmd/obsidian-help/blob/master/km/publish.js) (Language switcher)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Documentation vaults"]
  node_english["English source docs"]
  node_translations["Translated docs"]
end

subgraph group_localization["Localization workflow"]
  node_translation_scripts["Translation scripts"]
end

subgraph group_site["Published site experience"]
  node_language_switcher["Language switcher<br/>[publish.js]"]
  node_switcher_strings["Switcher strings<br/>[publish.strings.js]"]
  node_help_sites["Help language sites"]
  node_obsidian_publish["Obsidian Publish"]
end

node_contributors(("Contributors"))
node_readers(("Help readers"))

node_contributors -->|"edit first"| node_english
node_contributors -->|"refine translations"| node_translations
node_english -->|"provides source"| node_translation_scripts
node_translation_scripts -->|"apply changes"| node_translations
node_readers -->|"read help"| node_help_sites
node_help_sites -->|"offers switching"| node_language_switcher
node_language_switcher -.->|"uses localized text"| node_switcher_strings
node_english -->|"published as site"| node_obsidian_publish
node_translations -->|"published as sites"| node_obsidian_publish
node_obsidian_publish -->|"serves documentation"| node_help_sites

click node_english "https://github.com/obsidianmd/obsidian-help/tree/master/en"
click node_translations "https://github.com/obsidianmd/obsidian-help/tree/master/ar"
click node_translation_scripts "https://github.com/obsidianmd/obsidian-help/tree/master/scripts"
click node_language_switcher "https://github.com/obsidianmd/obsidian-help/blob/master/km/publish.js"
click node_switcher_strings "https://github.com/obsidianmd/obsidian-help/blob/master/km/publish.strings.js"
click node_help_sites "https://github.com/obsidianmd/obsidian-help/tree/master/en"

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_english,node_translations toneBlue
class node_translation_scripts toneAmber
class node_language_switcher,node_switcher_strings,node_help_sites,node_obsidian_publish toneMint
class node_contributors,node_readers toneIndigo
```

## Components

### Documentation vaults

- [English source docs](https://github.com/obsidianmd/obsidian-help/tree/master/en): `en`
- [Translated docs](https://github.com/obsidianmd/obsidian-help/tree/master/ar): `ar`

### Localization workflow

- [Translation scripts](https://github.com/obsidianmd/obsidian-help/tree/master/scripts): `scripts`

### Published site experience

- [Language switcher](https://github.com/obsidianmd/obsidian-help/blob/master/km/publish.js): `km/publish.js`
- [Switcher strings](https://github.com/obsidianmd/obsidian-help/blob/master/km/publish.strings.js): `km/publish.strings.js`
- [Help language sites](https://github.com/obsidianmd/obsidian-help/tree/master/en): `en`
- **Obsidian Publish**

### Other components

- **Contributors**
- **Help readers**

## Connections

- Contributors → English source docs: edit first
- Contributors → Translated docs: refine translations
- English source docs → Translation scripts: provides source
- Translation scripts → Translated docs: apply changes
- Help readers → Help language sites: read help
- Help language sites → Language switcher: offers switching (evidence: `km/publish.js`)
- Language switcher → Switcher strings: uses localized text
- English source docs → Obsidian Publish: published as site
- Translated docs → Obsidian Publish: published as sites
- Obsidian Publish → Help language sites: serves documentation
