docs
55 notes
How to write content for nuartz using Obsidian-flavored Markdown.
Reference for nuartz.config.ts — all available options for configuring your digital garden.
Deploy your nuartz garden to Vercel in a few steps.
Every note shows which other notes link to it.
Obsidian-style callout blocks in nuartz — all supported types with live examples.
nuartz respects your system theme and lets you toggle dark mode from the header.
Visualize connections between your notes with nuartz's interactive graph view.
Render inline and block math expressions using remark-math and rehype-katex.
Render Mermaid diagrams in nuartz — flowcharts, sequence diagrams, class diagrams, and more.
nuartz supports Obsidian Flavored Markdown — wikilinks, callouts, tags, highlights, comments, and more.
Set draft: true in frontmatter to exclude a page from listings and builds.
Client-side full-text search powered by FlexSearch, triggered by Cmd+K.
Code syntax highlighting in nuartz powered by Shiki — build-time highlighting with accurate grammar parsing.
Automatically generated table of contents in the right sidebar with active heading tracking.
Tag your notes and browse them at /tags. Folder index pages are auto-generated.
Wikilink syntax in nuartz — link between notes using [[double brackets]].
All frontmatter fields supported by nuartz — title, date, tags, draft, aliases, and more.
How to set up nuartz and start publishing your digital garden.
How nuartz processes markdown and renders pages — from remark to Next.js.
How to contribute to the nuartz project.
How to write custom remark and rehype plugins for the nuartz markdown pipeline.
Advanced topics for nuartz — architecture, plugins, and contributing.
How to build and preview your nuartz digital garden locally.
Navigation breadcrumbs showing the folder hierarchy for the current page.
BibTeX citation support using rehype-citation
Allow readers to leave comments on your pages via Giscus
A sidebar file explorer for browsing all notes and folders.
Auto-generated index pages for folders and tags.
Translate the nuartz interface into different languages
Overview of all Nuartz features for your digital garden.
Wikipedia-style page previews when hovering over internal links.
Distraction-free reading by hiding sidebars and UI elements.
Display a list of recently created or updated notes.
Automatically generated RSS feed for your content.
Auto-generated Open Graph preview images for social media sharing.
Single-page app style navigation for smooth page transitions.
Planned features and improvements on the nuartz roadmap.
How to set up a GitHub repository for your nuartz digital garden.
Deploy Nuartz to GitHub Pages, Vercel, Netlify, or your own server.
How nuartz structures its layout and the key React components you can customize.
Customize the page layout and component arrangement.
Why nuartz exists and who it's for.
Sites and gardens built with nuartz
How to update nuartz to the latest version