Skip to content
NNuartz

Documentation

Updated 2026-04-292 min read

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 15 starter template with shadcn/ui

Read more on the architecture page or explore creating plugins.

Linked from (1)