Interface: DocsSection

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

Properties

anchor?

optional anchor?: string

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

The heading's anchor on the page.

---

heading?

optional heading?: string

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

The section's heading; none for the text before the first heading.

---

id

id: string

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

url#anchor, plus ~n when a long section is cut in several.

---

text

text: string

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

The section's text, heading first.

---

title

title: string

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

The page's title.

---

url

url: string

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

---

version?

optional version?: string

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