Writing pages

Pages live in the pages/ directory. Two file types are supported.

Markdown pages

Files ending in .md are processed through a remark/rehype pipeline with syntax highlighting via Shiki.

pages/index.md
pages/guide/installation.md  →  /guide/installation

Standard CommonMark syntax works as expected. Code blocks are highlighted automatically based on the language tag:

```ts
const greeting = "hello";
```

TypeScript pages

Files ending in .ts can export a SafeHtml value directly. Import the html tagged template from @erikt/docgen to build the content:

import { html } from "@erikt/docgen";

export default html`
  <h1>Custom page</h1>
  <p>This page is written in TypeScript.</p>
`;

Values interpolated into html\`are HTML-escaped by default. Wrap trusted markup insafe()` to bypass escaping.

File-based routing

Each file maps to a URL path based on its location under pages/:

File	Route
pages/index.md	/
pages/about.md	/about
pages/guide/index.md	/guide
pages/guide/installation.md	/guide/installation

Ordering pages

Prefix a filename with a number to control the order it appears in the sidebar:

pages/guide/1-installation.md
pages/guide/2-configuration.md
pages/guide/3-pages.md

The prefix is stripped from both the URL and the displayed link text. Unprefixed files are sorted alphabetically after prefixed ones.

Sidebar navigation

Any directory under pages/ automatically generates a sidebar listing its pages. The sidebar appears on all pages within that directory, including the section index.

Static assets

Place files in a public/ folder at your project root and they will be copied to dist/ on build and served as-is by the dev server.