Skip to content
Nuartz

Configuration

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

Reference for apps/web/nuartz.config.ts and all available digital garden options.

On this page

The starter is configured through apps/web/nuartz.config.ts. 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 { fileURLToPath } from "node:url"
import { defineConfig } from "nuartz"
 
export default defineConfig({
  contentDir: path.join(path.dirname(fileURLToPath(import.meta.url)), "content"),
  homePage: "index",          // "index" | "recent"
  site: {
    title: "My Garden",
    description: "My personal notes",
    baseUrl: process.env.NUARTZ_SITE_URL ?? "https://example.com",
    locale: "en",
    verification: { google: "..." },
  },
  theme: { defaultMode: "system" },   // "system" | "light" | "dark"
  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 },
    ],
  },
})
Changes need

generate
bun run generate reads the config and content. There is no file watcher: after changing nuartz.config.ts or notes, run bun run generate again or restart bun dev.

Options

contentDir

Absolute path to the Markdown content directory. generate reads this value directly; it has no implicit default.

site

FieldTypeDescription
titlestringSite title, shown in the header and used in RSS, llms.txt, and meta tags.
descriptionstringSite description for SEO, RSS, and llms.txt.
baseUrlstringFull public URL, including any sub-path (e.g. https://user.github.io/repo). Used for canonical URLs, sitemap, RSS, OG tags, llms.txt, and the MCP server. Default http://localhost:3000. The starter reads NUARTZ_SITE_URL first.
localestringLanguage code for <html lang>, the RSS <language>, and the Pagefind search index. Default en.
verification{ google?: string; yandex?: string }Search engine ownership tokens, rendered as <meta> verification tags.

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 recent notes, newest first, 10 per page.

theme

defaultMode sets the colour scheme before the reader picks one: "system" (default), "light", or "dark". See Dark Mode.

features

Toggle individual features on or off. All default to true.

FeatureDescription
wikilinksWikilink syntax ([[note]]), embeds, and Markdown links to notes.
calloutsObsidian-style callouts (> [!type]).
tagsInline #tag support, tag badges, and the /tags pages.
backlinksThe Linked from panel on each note.
tocTable of contents from headings.
searchCmd+K / Ctrl+K search and its indexes.
darkModeDark/light theme toggle. When false, the site is always light.

markdown

RenderOptions passed to renderMarkdown() by generate. Values here override the starter's resolveLink, resolveAsset, and resolveTag, and markdown.features overrides features. The starter keeps control of baseUrl, knownSlugs, filePath, resolveEmbed, and renderBase so routing, embeds, and Bases keep working.

Configure the header links:

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 the link in a new tab (target="_blank", rel="noopener noreferrer").

Linked from (13)

Show 9 more references