Skip to content
Nuartz

Obsidian Compatibility

2026-03-01Updated 2026-09-103 min read
#feature#obsidian

nuartz supports Obsidian Flavored Markdown - wikilinks, callouts, tags, highlights, comments, and more.

On this page
Graph

Loading connections…

nuartz was designed to publish Obsidian vaults as websites with zero friction. Drop your vault's content folder into content/ and nuartz handles the rest.

Supported OFM features

Internal links using [[double brackets]] are resolved to the correct page URLs at build time. See Wikilinks for full syntax.

[[docs/getting-started]]
[[docs/getting-started|Custom label]]
[[docs/authoring-content#Frontmatter]]

Image embeds

Embed images with the ! prefix, optionally specifying dimensions:

![[screenshot.png]]
![[screenshot.png|600x400]]

Note embeds

Place a note embed in its own paragraph to include its content:

![[docs/getting-started]]
![[docs/getting-started#Installation]]
![[my-note#^block-id]]

A section embed includes its subheadings until the next heading at the same or a higher level. Add ^block-id at the end of a paragraph, or on a separate line after a block, to reference that block. Embedded content keeps its links relative to the source note.

Missing targets, circular references, and embeds beyond four nested notes stay as links. Inline note embeds also remain links. Draft and unpublished notes are excluded from the embed lookup.

Callouts

Obsidian-style callout blocks using the > [!type] syntax. See Callouts for all supported types.

> [!tip] My tip
> Content goes here.

Tags

Inline #hashtag syntax in prose is recognised and linked to the tag index. Tags in frontmatter are also supported. See Tags.

Highlights

Wrap text in ==double equals== to highlight it:

This is ==highlighted== text.

Comments

Obsidian comments (%%...%%) are stripped from the output - they never appear in the published site:

%% This comment is invisible to readers. %%

Arrows

-> and <- are converted to proper typographic arrows (→ and ←):

Input -> Process -> Output

Strikethrough

Standard ~~strikethrough~~ syntax is supported.

Frontmatter compatibility

nuartz reads the same frontmatter fields as Obsidian (title, tags, aliases, date, draft, etc.). See Frontmatter for the full field reference.

Tips for a smooth migration

Moving an existing vault
  1. Copy your vault's Markdown files into content/.
  2. Run bun dev and check the browser console for any broken wikilinks.
  3. Pages with draft: true are excluded from listings but still accessible by URL in dev mode.
Unsupported features

Some Obsidian features (Canvas files, Dataview queries, custom plugins) have no equivalent in nuartz. Plain Markdown notes and the OFM features listed above work out of the box.

Linked from (2)