Getting Started

publicsample-vaultv1·by Andre Pacheco·May 21, 2026

This is what a typical document looks like inside a Vault: three-column grid, sidebar on the left (collapsible tree, current doc highlighted), prose in the middle, and the right rail with the table of contents.

What's in the chrome

The chrome is the wrapper around your doc. It's selected by lib/chrome.ts based on whether the doc lives inside a vault, whether the role is client, or whether the frontmatter sets chrome: explicitly.

For this doc the chrome resolves to vault because there's a vault.yaml in an ancestor folder.

Heading two

Headings populate the right-rail ToC. Click any entry to jump.

Heading three

The ToC indents based on heading depth. Three levels deep are visible by default.

Wikilinks like Callouts and Stats resolve at publish time to the right URL. When you hover one, you get a popover preview with the target's first paragraph and metadata. The preview is prefetched so the next click is instant.

You can also use markdown-style links — they render the same way but skip the hover preview unless data-wikilink is added.

Read mode

Hit the Aa button in the header to enter reader mode. The chrome dissolves into a paper background, the prose centers, and the serif body font kicks in. Hit it again to go back to the regular chrome.

Dark theme stacks on top — try toggling the sun/moon next to the Aa button while reader mode is on.

Press Cmd+K (or /) anywhere in the vault to open the command palette. Search is scoped to the current vault by default and falls back to the global index when results run out.