3febbf05b0
Make onboarding simple and every feature easy to understand: - README: one-line value prop, "what you get" list, 60-second quick start, fixed install link (drop #LAST_RELEASE#), documentation hub. - Features.md: describe all 13 features in plain text with variants; add the missing Inline, Canvas and Backlink; expand Alias options. - Templates.md: simple -> composite learning curve plus recipes; add a "how to read" intro to TemplateExamples.md. - New Settings.md (Rules, Boot/Debug, commands) and FAQ.md. - Processor.md: clarify when to reach for it. Screenshot tooling (separate from the e2e test suite): - tools/screenshots: headless-Obsidian generator driven by its own wdio config; `npm run shots:pretty` captures every feature off/on, spotlights the changed element, and frames each shot carbon-style. - Regenerate all docs/img screenshots and add a before/after hero. - Add sharp devDependency for framing and a board.canvas fixture for the Canvas capture.
2.6 KiB
FAQ & troubleshooting
Does the plugin rename or edit my files?
No. By default it only changes what Obsidian displays — your filenames and file contents stay untouched. The two exceptions are opt‑in and clearly marked: the Alias feature modifies the metadata cache (not the file), and the Note Link feature rewrites [[link]] text inside your notes.
My title isn't showing. What do I check?
Go down this list:
- Is the feature enabled? Titles only appear where you turned a feature on (e.g. Explorer).
- Does the template match your frontmatter? The default template is
title, so the note needs atitle:key. If you use another key, set it as the Common main template. - Is the value a supported type? It must be a string, number, or list. An object (nested map with no leaf value) is ignored.
- Is the file excluded by a rule? Check Rules → File path rule — a white/black list may be skipping it. See Settings.
- Stale title? Run the Reload features command (Ctrl/Cmd+P).
- Still stuck? Enable Debug info (see below).
The value is a list. Which item is used?
By default the first item. You can instead join all items with a delimiter — see List values in Settings.
The value is an object / nested map. Why is it ignored?
Only a single string, number, or list can become a title. Point the template at a leaf value instead, e.g. book.title rather than book. See Template examples.
Can I show the title in more than one place?
Yes — each place is a separate feature you toggle independently (Explorer, Search, Tabs, Graph, Canvas, and more). You can even give each feature its own template.
Obsidian feels slow on a large vault.
- Enable Boot in background and/or set a Boot delay in Settings → Util.
- In templates, use a plain key (
title) instead of{{title}}when you only need one value.
How do I debug or report a problem?
- Enable Debug info in Settings → Util.
- Open the developer console: Ctrl/Cmd+Shift+I.
- Reproduce the issue and copy any logged errors.
- Open an issue on GitHub with the steps and the log.
How do I temporarily turn everything off?
Run the Disable features command. It reverts all titles to filenames without changing your saved settings; Reload features brings them back.