Installation
Clone the repository and install dependencies:
git clone https://github.com/syshin0116/nuartz.git
cd nuartz
bun installDevelopment
Start the dev server from the repository root:
bun devThis runs bun run generate once and then starts Next.js. Your garden is now live at http://localhost:3000.
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 buildThis 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:staticwrites a static site toapps/web/out, and the included GitHub Actions workflow (run manually from the Actions tab) builds and deploys it. Nonext.config.tsedits 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.