Skip to content
Nuartz

Getting Started

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

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

On this page
Prerequisites

Installation

Clone the repository and install dependencies:

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

Development

Start the dev server from the repository root:

bun dev

This runs bun run generate once and then starts Next.js. Your garden is now live at http://localhost:3000.

No content watcher

Code changes hot-reload, but notes and nuartz.config.ts are read by generate. After editing them, run bun run generate again or restart bun dev.

Adding Content

All content lives in apps/web/content/ as Markdown files. The home page is apps/web/content/index.md.

apps/web/content/
  index.md          # Home page
  docs/
    getting-started.md
    authoring-content.md
  notes/
    my-first-note.md

Each file needs frontmatter at the top:

---
title: My Note
date: 2026-03-01
tags:
  - example
description: A short description for link previews.
---

Configuration

Edit apps/web/nuartz.config.ts to customize your garden. See Configuration for all available options.

Building for Production

bun run build

This builds the nuartz package, runs generate, and runs next build. Preview it with bun run --cwd apps/web start.

Deploying

Nuartz can be deployed two ways:

  • GitHub Pages - free static hosting. bun run build:static writes a static site to apps/web/out, and the included GitHub Actions workflow (run manually from the Actions tab) builds and deploys it. No next.config.ts edits are needed.
  • Vercel - free tier with full features (dynamic OG images, external link previews). Import the repo and deploy in one click.

See Hosting for step-by-step instructions and a full comparison of what each mode supports.

Linked from (6)

Show 2 more references