Features

Writing Content

Use Markdown, frontmatter, links, assets, callouts, and page metadata to write lildocs pages.

Write normal Markdown files in your docs folder. lildocs supports standard and GitHub-flavored Markdown, syntax-highlighted code blocks with copy buttons, heading anchors, frontmatter, and local assets.

Page Titles

Page titles are inferred in this order:

  1. title in frontmatter
  2. The first h1
  3. The filename

Use frontmatter when the navigation label should differ from the visible page heading:

---
title: CLI Reference
---

# Command Line

Page Subtitles

Place a plain blockquote immediately after the page h1 to render short supporting copy as a subtitle:

# Command Line

> Choose the command and flags for building, previewing, or deploying docs.

Keep subtitles brief and descriptive. Blockquotes elsewhere on the page continue to render as regular quoted notes unless they use GitHub-style callout syntax.

Use normal relative Markdown links:

Read the [CLI reference](../reference/cli.md).

Use normal Markdown images for local assets:

![Small example image](../images/example.svg)

Small example image

Local assets referenced by Markdown are copied into the generated site.

Plain Markdown URLs

Every generated page has a plain Markdown file next to its route. For example, features/content/ has features/content.md, and the home page has index.md, even when its source is named README.md. Generated API reference pages also have Markdown files.

These files preserve the original Markdown text, including frontmatter, links, and code blocks. They are included in static builds and served as plain text by the development server.

Callouts

Use GitHub-style blockquote callouts to highlight notes, tips, important details, warnings, and cautions:

> [!NOTE]
> Useful context for readers who are skimming.

> [!WARNING]
> Something readers should check before continuing.

Supported callout types are NOTE, TIP, IMPORTANT, WARNING, and CAUTION.

Tip

Callouts are rendered as regular static HTML and work without client-side JavaScript.