Interface: DocsHit

Defined in: packages/docs/src/docs.ts:25

Properties

heading?

optional heading?: string

Defined in: packages/docs/src/docs.ts:32

---

href

href: string

Defined in: packages/docs/src/docs.ts:29

Where to send the reader: the page, and the section's anchor.

---

id

id: string

Defined in: packages/docs/src/docs.ts:27

The section: url#anchor.

---

snippet

snippet: string

Defined in: packages/docs/src/docs.ts:34

The start of the section's text, without its heading.

---

title

title: string

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

---

url

url: string

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

---

via

via: "words" | "meaning" | "both"

Defined in: packages/docs/src/docs.ts:36

Found by words, by meaning, or both.