FAQ

FAQ renders a divider-separated list of questions that expand inline. When the site assistant is enabled, a final row lets readers type their own question and get an answer generated from your docs, right inside the list.

12345678<FAQ askPlaceholder="Ask anything about Holocron...">
  <FAQ.Item question="What is Holocron?">
    Holocron is a Vite plugin that turns MDX files and a `docs.json` into a full documentation site.
  </FAQ.Item>
  <FAQ.Item question="Can I self-host it?">
    Yes. See [Deploy on Node.js](../deploy/node.mdx) or [Cloudflare](../deploy/cloudflare.mdx).
  </FAQ.Item>
</FAQ>

Ask row

The last row is an input. Submitting a question shows a loading indicator, then streams the answer right under the input. The question stays editable: change it and the arrow lights up again, so submitting replaces the answer.

Answers use the same gateway as the AI chat, so they search your docs before replying. Ask requests are one-shot: nothing is persisted and the chat drawer conversation is never touched.

The row only renders when assistant.enabled is true in docs.json. Pass ask={false} to hide it on a specific list.

Yes. This list was rendered with ask={false}.

12345<FAQ ask={false}>
  <FAQ.Item question="Is the ask row optional?" defaultOpen>
    Yes. This list was rendered with `ask={false}`.
  </FAQ.Item>
</FAQ>

Props

FAQ

askboolean

Show the trailing ask row. Ignored when the site assistant is disabled.

askPlaceholderstring

Placeholder text for the ask input.

FAQ.Item

questionstringrequired

The row title. title is accepted as an alias.

defaultOpenboolean

Render the answer expanded on first paint.