Class: Docs

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

A docs site's content in the page: search by words at once, by meaning once the reader has an embedding model, and the tools an assistant (or the browser's own agents) uses to read the docs.

Constructors

Constructor

new Docs(ai, options): Docs

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

Parameters

ai

Leuria

options

DocsOptions

Returns

Docs

Properties

ai

readonly ai: Leuria

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

---

index?

optional index?: VectorIndex<{ url: string; }>

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

Search by meaning, built with the reader's model; created once the corpus is loaded.

Accessors

pages

Get Signature

get pages(): DocsPage[]

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

Returns

DocsPage[]

---

pageTools

Get Signature

get pageTools(): ToolDefinition<Record<string, unknown>, unknown>[]

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

Tools for the browser's own agents (WebMCP): the same, plus opening a page for the reader.

Returns

ToolDefinition<Record<string, unknown>, unknown>[]

---

site

Get Signature

get site(): string | undefined

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

Returns

string | undefined

---

tools

Get Signature

get tools(): ToolDefinition<Record<string, unknown>, unknown>[]

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

Tools for the docs assistant: search, read a page, list the pages.

Returns

ToolDefinition<Record<string, unknown>, unknown>[]

Methods

currentPage()

currentPage(): DocsPage | undefined

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

The page open on screen, if it is a docs page.

Returns

DocsPage | undefined

---

destroy()

destroy(): void

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

Returns

void

---

expose()

expose(): () => void

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

Offer pageTools to the browser's agents; returns how to take them back.

Returns

() => void

---

load()

load(): Promise<DocsCorpus>

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

The corpus, fetched on first use.

Returns

Promise<DocsCorpus>

---

meaningState()

meaningState(): IndexState | undefined

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

Search by meaning: waiting for a model, indexing, ready.

Returns

IndexState | undefined

---

open()

open(url): void

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

Show a page to the reader.

Parameters

url

string

Returns

void

---

page()

page(url): DocsPage | undefined

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

The page at this address (any form: full URL, trailing slash, hash).

Parameters

url

string

Returns

DocsPage | undefined

---

passage()

passage(hit): Promise<string>

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

The text behind a hit: what the site's search found, the corpus's section, or the section read from the page.

Parameters

hit

DocsHit

Returns

Promise<string>

---

read()

read(url): Promise<string>

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

A page as Markdown: from the corpus, else read from the site (once).

Parameters

url

string

Returns

Promise<string>

---

search()

search(query, __namedParameters?): Promise<DocsHit[]>

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

Search the docs: by words at once, merged with search by meaning when it is ready.

Parameters

query

string

__namedParameters?

DocsSearchOptions = {}

Returns

Promise<DocsHit[]>

---

section()

section(id): DocsSection | undefined

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

A section by its id (url#anchor).

Parameters

id

string

Returns

DocsSection | undefined

---

subscribe()

subscribe(listener): () => void

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

Be told when the corpus loads or search by meaning changes state.

Parameters

listener

() => void

Returns

() => void

---

version()

version(): string | undefined

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

The version the reader is on.

Returns

string | undefined