Interface: DocsPage

Defined in: packages/docs/src/corpus.ts:8

What a docs site gives Leuria: its pages, and the same pages cut into sections for search. Built once, at build time (@leuria/docs/build), and fetched by the page when the reader first searches or asks. A light corpus leaves the text out: pages are then read from the site itself.

Properties

description?

optional description?: string

Defined in: packages/docs/src/corpus.ts:12

---

markdown?

optional markdown?: string

Defined in: packages/docs/src/corpus.ts:14

The page's text, as Markdown (front matter and MDX imports removed). Left out of a light corpus.

---

title

title: string

Defined in: packages/docs/src/corpus.ts:11

---

url

url: string

Defined in: packages/docs/src/corpus.ts:10

The page's path on the site, e.g. /docs/guides/tools.

---

version?

optional version?: string

Defined in: packages/docs/src/corpus.ts:16

For versioned docs: the version this page belongs to.