Skip to content
Nuartz

Authoring Content

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

How to write content for nuartz using Obsidian-flavored Markdown.

On this page

All content in nuartz goes in the apps/web/content/ directory. The home page lives at apps/web/content/index.md. Any Markdown file in this directory is rendered by nuartz, except unpublished notes and paths under _ or . folders.

Recommended Editor

Use Obsidian to edit your notes. It gives you a live preview, graph view, and the same syntax that nuartz supports.

Frontmatter

Every note starts with YAML frontmatter between --- fences:

---
title: Example Title
date: 2026-03-01
draft: false
tags:
  - example-tag
description: A short description for link previews and SEO.
aliases:
  - alternate-name
---
FieldDescription
titlePage title. Falls back to the filename if omitted.
datePublish date in YYYY-MM-DD format.
tagsList of tags for categorization.
descriptionUsed for meta tags, RSS, and listings.
draftSet to true to hide the page from the published site.
aliasesAlternate names that wikilinks resolve to; they also work as redirect URLs.

See Frontmatter for every field.

Link to other notes using double brackets:

  • [[docs/getting-started]] - links to docs/getting-started
  • [[docs/getting-started|Get Started]] - links with custom text: Get Started
  • [[docs/features/callouts#Showcase]] - links to a heading anchor

See Wikilinks for the full syntax reference.

Callouts

Use Obsidian-style callout blocks to highlight information:

This is a note

Callouts support bold, italic, code, and wikilinks inside them.

> [!note] This is a note
> Callouts support **bold**, *italic*, `code`, and [[wikilinks]] inside them.

See Callouts for all supported types.

Tags

Add tags in frontmatter or inline with #tag syntax. Tags create automatic index pages at /tags/tag-name.

Code Blocks

Fenced code blocks with language identifiers get syntax highlighting powered by Shiki:

function greet(name: string): string {
  return `Hello, ${name}!`
}

Math

nuartz supports LaTeX math via KaTeX.

Inline: $E = mc^2$ renders as E=mc2E = mc^2

Block math:

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Renders as:

∑i=1ni=n(n+1)2\sum_{i=1}^{n} i = \frac{n(n+1)}{2}

Mermaid Diagrams

Create diagrams using fenced code blocks with the mermaid language. See Mermaid Diagrams for examples.

Images

Place images anywhere in apps/web/content/ and embed them. As in Obsidian, ![[my-image.png]] finds the file by exact path, path relative to the note, or unique file name:

![[my-image.png]]
![[my-image.png|300]]

Standard Markdown image syntax also works:

![Alt text](./images/photo.png)

Video, audio, PDF, and other attachments are covered in Obsidian Compatibility.

Linked from (12)

Show 8 more references