Wikilinks let you link between notes using [[double brackets]], just like in Obsidian. nuartz resolves these links at build time and renders them as clickable links with graph view connections.
Syntax
Basic Link
[[docs/getting-started]]Renders as: docs/getting-started
The link text is the target as written, not the note's title. Targets are resolved like Obsidian does:
- The exact path from the content root (
docs/getting-started) - A path relative to the current note (
./sibling,../other); targets starting with.only use this rule - A file name or alias that exactly one note has (
[[getting-started]])
Matching ignores case, a trailing .md, and treats spaces as hyphens. A link that resolves to no published note gets the broken class.
Custom Display Text
[[docs/getting-started|Get Started Guide]]Renders as: Get Started Guide
Use the pipe | to set custom link text.
Heading Anchor
[[docs/authoring-content#Frontmatter]]Renders as: docs/authoring-content > Frontmatter
Link directly to a specific heading within a note. Without display text, the link reads target > heading. [[#Heading]] links to a heading on the current page, and [[note#^block-id]] links to a block.
Combined
[[docs/authoring-content#Frontmatter|See frontmatter docs]]Renders as: See frontmatter docs
Standard Markdown links
Ordinary Markdown links to notes resolve the same way and count as links for backlinks and the graph:
[Getting started](getting-started.md)
[Install section](docs/getting-started.md#Installation)Links to other files ([slides](deck.pdf)) point to the attachment.
Embeds
Embed images and other attachments using the ! prefix:
![[my-image.png]]With a width, or width and height in pixels:
![[my-image.png|300]]
![[my-image.png|400x300]]Video, audio, PDF, and note embeds are covered in Obsidian Compatibility.
How It Works
nuartz resolves wikilinks during the Markdown-to-HTML transformation:
- The parser finds
[[...]]patterns (and Markdown links to.mdfiles) duringbun run generate - It resolves the target against the published notes
- It generates an
<a class="wikilink">with the resolved URL - The link is registered for graph view and backlinks
nuartz uses the same wikilink syntax as Obsidian, so your notes work in both environments without changes.
Related
- Authoring Content - full syntax reference
- Graph View - see how wikilinks build your note graph
- Configuration - enable or disable wikilinks