NNuartz

Configuration

2026-03-01Updated 2026-03-193 min read·
#nuartz#configuration

Reference for nuartz.config.ts — all available options for configuring your digital garden.

nuartz is configured through nuartz.config.ts in your project root. If your editor has TypeScript support, it will warn you about configuration errors as you type.

Tip

Use a TypeScript-aware editor like VS Code for autocomplete and validation.

Full Config Reference

import path from "node:path"
import { defineConfig } from "nuartz"
 
export default defineConfig({
  contentDir: path.join(process.cwd(), "content"),
  homePage: "index",          // "index" | "recent"
  site: {
    title: "My Garden",
    description: "My personal notes",
    baseUrl: "https://example.com",
  },
  features: {
    wikilinks: true,
    callouts: true,
    tags: true,
    backlinks: true,
    toc: true,
    search: true,
    darkMode: true,
  },
  nav: {
    links: [
      { label: "GitHub", href: "https://github.com/user/repo", external: true },
    ],
  },
})

Options

contentDir

Path to the directory containing your Markdown files. Defaults to content/ in the project root.

homePage

Controls what is shown at /:

ValueBehaviour
"index" (default)Renders content/index.md as a normal page. Falls back to recent notes if the file doesn't exist.
"recent"Shows a listing of all notes sorted by date frontmatter (most recent first).
homePage: "index"   // show content/index.md
homePage: "recent"  // show recent notes list

site

FieldTypeDescription
titlestringSite title, shown in the header and used in RSS/meta tags.
descriptionstringSite description for SEO and link previews.
baseUrlstringCanonical URL of your deployed site (used for RSS, sitemap, OG tags).

features

Toggle individual features on or off:

FeatureDefaultDescription
wikilinkstrueWikilink syntax support ([[note]]).
calloutstrueObsidian-style callouts (> [!type]).
tagstrueTag pages and inline #tag support.
backlinkstrueShow which notes link to the current page.
toctrueAuto-generated table of contents from headings.
searchtrueFull-text search with Cmd+K / Ctrl+K.
darkModetrueDark/light theme toggle.

Configure the navigation bar:

nav: {
  links: [
    { label: "GitHub", href: "https://github.com/...", external: true },
    { label: "About", href: "/about" },
  ],
}
  • label: Display text for the link.
  • href: URL (relative for internal, absolute for external).
  • external: Set true to open in a new tab with an external link icon.
Hot Reload

Changes to nuartz.config.ts are picked up automatically during development — no restart needed.

Linked from (10)