Skip to main content

Interface: Options

Defined in: index.ts:40

Properties​

app?​

optional app?: string

Defined in: index.ts:42

The name Leuria shows when the reader connects the site. Default: the site's title.

askButton?​

optional askButton?: "navbar" | "floating" | "none"

Defined in: index.ts:55

Where the Ask button goes: navbar (default), floating (bottom right), or none (you place <leuria-ask-button> yourself).

connectButton?​

optional connectButton?: boolean

Defined in: index.ts:64

Also put the "Connect your AI" button in the navbar. Default false: the Ask panel offers it when needed.

docsPluginIds?​

optional docsPluginIds?: string[]

Defined in: index.ts:98

Only these docs plugin instances. Default: every one.

fallback?​

optional fallback?: "ask" | "auto"

Defined in: index.ts:96

Readers without Leuria: ask (default) proposes Leuria first, and this browser's AI or your server answer only once the reader picks one (for the page); auto uses them at once.

needs?​

optional needs?: Needs

Defined in: index.ts:79

What the Ask panel needs, so Leuria recommends a model that fits and no bigger. Default { tools: true, effort: "light" }: it searches and reads your pages, then answers.

pageEmbeddings?​

optional pageEmbeddings?: boolean

Defined in: index.ts:73

A small embedding model in the page (@leuria/web-embed, about 40 MB, downloaded when the reader agrees) for readers whose AI can't embed. Its runtime comes from a CDN (jsDelivr) and the model from Hugging Face. Install @leuria/web-embed to use it. Default false.

optional search?: boolean

Defined in: index.ts:62

Add a search to the navbar (⌘K), by words and by meaning. For sites without one: leave it off next to Algolia DocSearch or a local search. It makes the docs index readers download bigger: it keeps the pages' text, to find any word. Default false.

server?​

optional server?: ServerOptions

Defined in: index.ts:90

Your server as the last resort, for readers with no AI of their own.

site?​

optional site?: string

Defined in: index.ts:44

The name the assistant gives the docs. Default: the site's title.

skills?​

optional skills?: string[]

Defined in: index.ts:88

Skills that guide the reader's AI on your site, in the npx skills syntax: "/" for your site's own static/.well-known/agent-skills/, owner/repo, owner/repo@skill, or owner/repo/path#commit pinned to a commit. Leuria fetches them, shows them to the reader when they connect, and gives them to their AI on your site only. Readers without the Leuria app don't get them.

suggestions?​

optional suggestions?: string[]

Defined in: index.ts:48

Questions offered before the first one.

system?​

optional system?: string

Defined in: index.ts:50

Replaces the assistant's instructions.

title?​

optional title?: string

Defined in: index.ts:46

The Ask panel's title. Default "Ask the docs".

webmcp?​

optional webmcp?: boolean

Defined in: index.ts:66

Offer the docs tools to the browser's own agents (WebMCP). Default true.