Documentation

Everything about ondocs, from the first install to the index format. Every page here is also in the index, so you can ask instead.

  1. IntroductionWhat ondocs is: open-source Ask AI for your docs, with an MCP server for agents, from one static index. Who it is for, and when it is the wrong tool.
  2. Getting startedInstall the package, build the index, deploy the endpoint and add the dialog.
  3. Try it locallyRun the whole pipeline on your machine with mock mode and ondocs dev, no API key.
  4. TroubleshootingThe messages a new site shows most often, from the package manager, the build, the dialog and the endpoint, what causes each one and how to fix it.

These docs, live with each plugin: Starlight, Docusaurus and VitePress.