Skip to content

Obsidian compatibility ​

Znote can open an Obsidian vault directly (any folder carrying .obsidian/) and follows its configuration. Compatibility works at the read/render level: your note contents are never rewritten, so the vault keeps working in Obsidian.

TIP

These features work in every vault — not just Obsidian ones. And with the companion plugin, you can run Znote code blocks from inside Obsidian.

  • Typing [[ completes against your vault notes and inserts [[folder/Name]]. The @ completion in prose also inserts a wikilink.
  • [[Target]] and [[Target|alias]] render as a single clickable widget; the raw text comes back when the caret is inside.
  • Resolution matches Obsidian: note basename or vault-relative path, case-insensitive. Frontmatter aliases also resolve ([[Alias]] finds the note).
  • [[Note#Heading]] opens the note and scrolls to the heading. Unresolved targets render dimmed and are not clickable.

Embeds & transclusion ​

  • ![[image.png]] embeds resolve against the vault attachments and render inline. Obsidian's size syntax is honoured: ![[img.png|900]], ![[img.png|640x480]].
  • ![[Note]] renders the target note inline as a bordered block with a clickable header. ![[Note#Heading]] embeds only that section. Transclusion is one level deep, so cycles can't recurse.

Callouts ​

> [!type] Title renders with Obsidian's per-type colour, icon and bold title. Supported types include note, abstract/summary/tldr, info, todo, tip/hint/important, success/check/done, question/help/faq, warning/caution/attention, failure/fail/missing, danger/error, bug, example, quote/cite.

%%comments%% and ^block-anchors are hidden in preview (shown raw while the caret is on them).

Attachments ​

Pasted images are written into the attachments folder as Pasted image <timestamp>.png and inserted as ![[name]] — no machine-bound absolute paths.

  • Znote vaults use <vault>/attachments/.
  • Obsidian vaults follow attachmentFolderPath from .obsidian/app.json (vault root, next to the note, or a fixed folder).
  • A file pasted from the OS file manager is copied into the attachments folder and embedded.
  • The attachments folder is hidden from the folder tree (but still indexed so embeds resolve).

Inline title ​

The filename is displayed as an editable heading above the note content. Press Enter or click away to commit the rename; Enter or ArrowDown drops the caret onto the first content line. A brand-new note opens focused in its title, ready to be named.

  • Setting: Settings → Editor → Interface → "Inline title" (default on, saved per vault).
  • In an Obsidian vault, .obsidian/app.json's showInlineTitle is the source of truth — and toggling it in Znote writes back to app.json, so both apps stay in sync.
  • When inline title is off, a small editable tab title bar appears in the action bar instead.

Readable line length ​

The content column is limited to Obsidian's comfortable 700 px.

  • Setting: Settings → Editor → Interface → "Readable line length" (default on, saved per vault, applied live).
  • Same two-way sync with .obsidian/app.json's readableLineLength.

Note naming ​

In every vault the filename is the title: notes are renamed explicitly (inline title or tree Rename). The first line of the content never renames the file.

Znote — your notes, your files, your machine.