Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Glossary

TermMeaning in this repo
AppThe root runtime object from packages/api/src/lib/context.svelte.ts. It owns workspace, vault, configuration, commands, metadata, and plugin management.
VaultThe file-backed note store exposed through API storage abstractions. New browser-local vaults use OPFS by default; legacy/manual setups can still use Lightning FS.
OPFS vaultA browser-local vault whose canonical file bytes live in the origin private file system.
Real-folder vaultA vault backed by a user-selected directory through the File System Access API.
Vault profileBrowser-persisted startup state that records which vault backend to reopen and the stable vault id used for scoped IndexedDB data.
Sidecar statsIndexedDB metadata used to supplement browser file handles with vault stat fields such as creation time and folder modified time.
WorkspaceThe runtime model for panes, splits, tabs, leaves, and views. It is not just the repo root.
LeafA single visible view host inside the workspace tree. Leaves can be duplicated, split, and persisted in layout state.
ViewA runtime screen attached to a leaf, such as text, markdown, file explorer, or search.
Core pluginA plugin loaded directly by the workspace shell during boot, for example the app, file explorer, markdown, search, and bases plugins.
Community pluginA plugin discovered from /.obsidian/plugins and loaded through PluginManager.
Configuration schemaJSON-schema-like definitions registered into the app configuration system and rendered in the settings UI.
Metadata cacheThe app service that tracks parsed file metadata and emits change events used by search and metadata views.
Data adapterThe storage backend used by the vault and directory watcher.