Skip to content
Nuartz

Obsidian Compatibility

2026-03-01Updated 2026-11-024 min read
View Markdown

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

On this page

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

Supported OFM features

Internal links using [[double brackets]] are resolved to the correct page URLs at build time, by exact path, path relative to the note, or unique file name. Standard Markdown links to notes ([text](note.md), [text](note.md#heading)) resolve the same way and count as backlinks. See Wikilinks for full syntax.

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

Attachments and media

Embed files with the ! prefix. Attachments are found the way Obsidian finds them: the exact path from the content root, then a path relative to the note, then the file name when only one file has it. They are copied to /content/... during bun run generate; files under _ or . folders are never copied.

![[screenshot.png]]            image
![[screenshot.png|600]]        image, 600px wide
![[screenshot.png|600x400]]    image, width and height
![alt|300](images/photo.png)   standard syntax with a size
![[demo.mp4]]                  <video> player (mp4, webm, mov, ogv, mkv)
![[talk.mp3]]                  <audio> player (mp3, wav, m4a, ogg, flac, 3gp)
![[paper.pdf]]                 embedded PDF viewer
![[archive.zip]]               download link
![](https://youtu.be/VIDEO_ID)  YouTube player
![](https://example.com/a.mp4)  external video

An attachment that cannot be found renders as its file name with the embed-missing class and an "Attachment not found" tooltip. [text](file.pdf) links to the attachment.

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 list item, or on a separate line after a block (table, quote, callout, code), to reference that block. An id on a list item's first line names the whole item, nested items included, and ![[note#^id]] finds blocks nested inside lists. 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, including foldable callouts ([!type]-, [!type]+) and custom types. See Callouts.

> [!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 typographic arrows (→, ←, ↔):

Input --> Process --> Output

Strikethrough

Standard ~~strikethrough~~ syntax is supported.

Frontmatter compatibility

nuartz reads the same frontmatter fields as Obsidian (title, tags, aliases, cssclasses, ...), in the list, single-value, or comma-separated forms Obsidian accepts. See Frontmatter for the full field reference.

Tips for a smooth migration

Moving an existing vault
  1. Copy your vault into apps/web/content/. .obsidian/ and .trash/ are ignored.
  2. Run bun dev. Broken links are dimmed with a dashed underline. bun run validate lists them, and bun run check fails on them.
  3. Pages with draft: true or published: false are not published, also in dev mode.
Unsupported features

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

Linked from (4)