Getting Started

Prerequisites

Installation

Clone the repository and install dependencies:

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

Start the dev server with hot reload:

bun dev

Your garden is now live at http://localhost:3000.

All content lives in the content/ directory as Markdown files. The home page is content/index.md.

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.
---

Edit nuartz.config.ts in the project root to customize your garden. See Configuration for all available options.

bun run build

Nuartz can be deployed two ways:

GitHub Pages — free static hosting. Uncomment output: "export" in next.config.ts and push. The included GitHub Actions workflow builds and deploys automatically.
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.

Next Steps