Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/chrisgrieser/shimmering-obsidian/llms.txt

Use this file to discover all available pages before exploring further.

Shimmering Obsidian provides two dedicated documentation search commands: oh for end-user help articles and odd for the plugin developer reference. Results open directly in your default browser or can be copied to the clipboard.
Both oh and odd retrieve data over the network when first run. Alfred caches the results locally so subsequent searches are instant — make sure you have a network connection available for the initial load or to refresh stale results.

​
Official help documentation — oh

Keyword: oh The oh command searches the official Obsidian help documentation. It works from a regularly-updated cached index of help.obsidian.md, so results are fast and reflect current content. The index includes page headings in addition to page titles, letting you navigate directly to a specific section of a long help article rather than just the top of the page.
ShortcutAction
⏎Open the result in your default browser
⌥ + ⏎Copy the link to the clipboard

​
Example queries

oh quick switcher        → finds the Quick Switcher core plugin page
oh callout               → finds sections about callout blocks
oh yaml frontmatter      → finds pages and headings related to YAML metadata

​
Plugin developer documentation — odd

Keyword: odd (obsidian developer docs) The odd command searches the official Obsidian developer documentation — the API and plugin-authoring reference hosted at docs.obsidian.md. It also includes the CodeMirror 6 reference, since Obsidian’s editor is built on CodeMirror and plugin authors frequently need to look up CodeMirror classes and functions alongside Obsidian’s own API. Results are organised by category (shown in the subtitle), making it easy to distinguish between Obsidian API pages and CodeMirror reference entries at a glance. Alfred caches the results for seven days so repeated searches stay fast.
ShortcutAction
⏎Open the result in your default browser
⌥ + ⏎Copy the link to the clipboard

​
Example queries

odd vault               → finds Vault class reference and related guides
odd workspace leaf      → finds WorkspaceLeaf API docs
odd registerEvent       → finds event registration documentation
odd EditorView          → finds the CodeMirror EditorView class
The odd search supports camelCase matching. Searching for registerEvent also matches register event and register-event — useful when you remember a method name but are unsure of the exact casing or separator used in the docs.

​
Comparison

Featureohodd
Target audienceAll Obsidian usersPlugin developers
Documentation sitehelp.obsidian.mddocs.obsidian.md + codemirror.net/docs
Searches headingsYesNo — page-level only
Open in browser⏎⏎
Copy link⌥ + ⏎⌥ + ⏎
CachingPre-built index (regularly updated)Alfred cache, refreshed weekly

Build docs developers (and LLMs) love

Get started for freeTalk to us