Skip to content

Obsidian companion plugin

Znote Companion is a small Obsidian plugin, shipped with Znote, that bridges the two apps: open any note in Znote with one click, and run code blocks from inside Obsidian — the result is written into the markdown and displayed right back in Obsidian.

Install

In an Obsidian vault, open Settings → Editor → Obsidian → Companion plugin and click Install. Znote copies the plugin into .obsidian/plugins/znote-companion and enables it — then reload Obsidian to activate it.

The first time you open an Obsidian vault in Znote, a dialog offers the install automatically.

What it adds inside Obsidian

  • Open in Znote — command palette, file menu, editor context menu, ribbon icon, and a note-header action on every markdown view.
  • ▶ Run in Znote — on executable code blocks (js, bash, batch, powershell, pwsh), in both reading view and editing mode. Editing mode also gets a copy button next to it.
  • Result styling — persisted output blocks render as labeled RESULT blocks visually attached to their code block, and znote-run-*.png snapshots display with proper spacing.

The round trip

  1. Write a code block in Obsidian.
  2. Click ▶ Run in Znote — the note opens in Znote and the block runs.
  3. The result is persisted into the .md file.
  4. Back in Obsidian, the result appears under the block.

The plugin uses Znote's URL scheme, which you can also use from anywhere else:

znote://open?vault=<absolute vault path>&file=<vault-relative .md path>
  • A vault already known to Znote opens directly (an existing window is focused, or the app boots straight into it — including from a cold start).
  • A vault Znote has never opened shows a native confirmation first, with the exact paths and a note that a .znote/ folder will be created.

INFO

The znote:// scheme is registered by the installed Znote app — a development instance isn't reachable from Obsidian.

Znote — your notes, your files, your machine.