How obsidianmd/obsidian-help works
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 English source docs · ar Translated docs · scripts Translation scripts · publish.js Language switcher
Components 9
Documentation vaults
Localization workflow
- Translation scripts
scripts
Published site experience
- Language switcher
km/publish.js - Switcher strings
km/publish.strings.js - Help language sites
en - Obsidian Publish
Other components
- Contributors
- Help readers
Connections 10
- 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
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