Skip to content
Nuartz

Documentation

59 notes

Nuartz turns your Obsidian vault into a Next.js website. It handles wikilinks, callouts, backlinks, graph view, and search - you get a normal Next.js app you can customise with React components and shadcn/ui.

Get Started

git clone https://github.com/syshin0116/nuartz.git
cd nuartz
bun install
bun dev

Drop your Markdown files into apps/web/content/ and start writing.

  1. Write content using Markdown + Obsidian syntax
  2. Configure site metadata and behaviour
  3. Understand the layout system
  4. Build and preview the site locally
  5. Deploy to GitHub Pages, Vercel, or your own server

Features

For a full list, visit the features page.

Architecture

Nuartz is split into two packages:

PackageDescription
packages/nuartzHeadless data library - markdown parsing, wikilinks, backlinks, search index
apps/webNext.js 16 starter template with shadcn/ui

Read more on the architecture page or explore creating plugins.

Bases2026-11-02

Obsidian Bases (.base) tables, cards, and lists, evaluated over your published notes at build time.

#nuartz#features#bases
Canvas2026-11-02

Obsidian Canvas (.canvas) files published as pannable, zoomable pages.

#nuartz#features#canvas
Architecture2026-11-02

How nuartz processes markdown and renders pages, from remark to Next.js.

Contributing2026-11-02

How to contribute to the nuartz project.

Creating Layout Components2026-11-02

nuartz's UI is built from standard Next.js React components using Tailwind CSS v4. This guide explains how to add new components or extend existing ones. All layout and UI components live in…

Creating Plugins2026-11-02

How to write custom remark and rehype plugins for the nuartz markdown pipeline.

Advanced2026-11-02

Advanced topics for nuartz - architecture, plugins, and contributing.

Paths and Slugs2026-11-02

nuartz uses a simple, file-system-based slug system. Understanding how file paths map to URL slugs helps you reason about links, content organisation, and wikilink resolution. Given a content/…

Building Your Site2026-11-02

How to build and preview your nuartz digital garden locally.

Breadcrumbs2026-11-02

Navigation breadcrumbs showing the folder hierarchy for the current page.

Citations2026-11-02

BibTeX citation support using rehype-citation

Comments2026-11-02

Allow readers to leave comments on your pages via Giscus

Docker Support2026-11-02

Nuartz does not ship a Dockerfile out of the box. This page shows how to add one yourself. You can containerize Nuartz using Docker to run it locally without installing Node.js or Bun, or to deploy…

Explorer2026-11-02

A sidebar file explorer for browsing all notes and folders.

Folder and Tag Listings2026-11-02

Auto-generated index pages for folders and tags.

Internationalization2026-11-02

Translate the nuartz interface into different languages

Features2026-11-02

Overview of all Nuartz features for your digital garden.

Popover Previews2026-11-02

Wikipedia-style page previews when hovering over internal links.

Reader Mode2026-11-02

Distraction-free reading by hiding sidebars and UI elements.

Recent Notes2026-11-02

Display a list of recently created or updated notes.

RSS Feed2026-11-02

Automatically generated RSS feed for your content.

Social Images2026-11-02

Auto-generated Open Graph preview images for social media sharing.

SPA Routing2026-11-02

Single-page app style navigation for smooth page transitions.

Upcoming Features2026-11-02

Planned features and improvements on the nuartz roadmap.

GitHub Repository Setup2026-11-02

How to set up a GitHub repository for your nuartz digital garden.

Hosting2026-11-02

Deploy Nuartz to GitHub Pages, Vercel, Netlify, or your own server.

Layout & Components2026-11-02

How nuartz structures its layout and the key React components you can customize.

Layout2026-11-02

Customize the page layout and component arrangement.

Philosophy2026-11-02

Why nuartz exists and who it's for.

Frontmatter2026-11-02

nuartz parses YAML frontmatter using gray-matter. Frontmatter is the block of ----delimited YAML at the top of a Markdown file. See Frontmatter for what each field does. normalizeFrontmatter() in…

#plugin
Hard Line Breaks2026-11-02

By default, single newlines in Markdown are treated as spaces (they do not produce a <br>). nuartz enables the remarkBreaks plugin so that single newlines in your prose render as hard line breaks —…

#plugin
Processing Pipeline2026-11-02

Nuartz processes Markdown through a remark → rehype pipeline. Each stage is handled by plugins that transform the abstract syntax tree (AST) before producing the final HTML. All plugins are wired…

Obsidian Compatibility2026-11-02

nuartz implements the most commonly used Obsidian Markdown extensions so you can drop content written in Obsidian directly into your garden without modification. [[note]] is converted to a hyperlink…

#plugin
Draft Filtering2026-11-02

nuartz automatically excludes draft and private content from the site. This is handled at the filesystem level by getAllMarkdownFiles() in packages/nuartz/src/fs.ts, in every mode including bun dev.…

#plugin
Syntax Highlighting2026-11-02

nuartz uses rehype-pretty-code (powered by Shiki) for syntax highlighting. This gives you accurate, VS Code-quality highlighting with zero runtime JavaScript. See docs/features/syntax-highlighting…

#plugin
Table of Contents2026-11-02

nuartz automatically generates a table of contents (TOC) from heading levels in your Markdown. See docs/features/table-of-contents for what it looks like. During rendering, a custom rehypeExtractToc…

#plugin
Showcase2026-11-02

Sites and gardens built with nuartz

Upgrading nuartz2026-11-02

How to update nuartz to the latest version

AI Agents2026-11-02

Markdown versions of every note, llms.txt, content negotiation, and a read-only MCP server for AI agents.

#feature#ai
Authoring Content2026-03-01

How to write content for nuartz using Obsidian-flavored Markdown.

#nuartz#content#obsidian
Configuration2026-03-01

Reference for apps/web/nuartz.config.ts and all available digital garden options.

#nuartz#configuration
Deployment2026-03-01

Deploy your nuartz garden to Vercel in a few steps.

#deployment#vercel
Backlinks2026-03-01

Every note shows which other notes link to it.

#feature#navigation
Callouts2026-03-01

Obsidian-style callout blocks in nuartz - all supported types with live examples.

#nuartz#features#callouts
Dark Mode2026-03-01

nuartz respects your system theme and lets you toggle dark mode from the header.

#feature#ui
Graph View2026-03-01

Visualize connections between your notes with nuartz's interactive graph view.

#nuartz#features#graph
LaTeX2026-03-01

Render inline and block math expressions using remark-math and rehype-katex.

#feature#math
Mermaid Diagrams2026-03-01

Render Mermaid diagrams in nuartz — flowcharts, sequence diagrams, class diagrams, and more.

#nuartz#features#mermaid
Obsidian Compatibility2026-03-01

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

#feature#obsidian
Private Pages2026-03-01

Set draft: true in frontmatter, or use a _ or . folder, to keep a page off the site.

#feature#publishing
Search2026-03-01

Client-side full-text search powered by Pagefind, triggered by Cmd+K.

#feature#navigation
Syntax Highlighting2026-03-01

Code syntax highlighting in nuartz powered by Shiki — build-time highlighting with accurate grammar parsing.

#nuartz#features#code
Table of Contents2026-03-01

Automatically generated table of contents in the right sidebar with active heading tracking.

#feature#navigation
Tags2026-03-01

Tag your notes and browse them at /tags. Folder index pages are auto-generated.

#feature#navigation
Wikilinks2026-03-01

Wikilink syntax in nuartz - link between notes using [[double brackets]].

#nuartz#features#wikilinks
Frontmatter2026-03-01

All frontmatter fields nuartz reads - title, dates, tags, aliases, draft, and more.

#reference#authoring
Getting Started2026-03-01

How to set up nuartz and start publishing your digital garden.

#nuartz#setup
bases-demo
canvas-demo