Doc platforms
These guides cover widget placement and content indexing for common documentation stacks.
Each page shows where to put the Knoku script so it loads on every page, and how to get your Markdown into the index.
Index your content first
Before embedding the widget, connect a source:
| Approach | When to use |
|---|---|
| GitHub repo sync | Docs live as Markdown in a GitHub repo (recommended) |
| Website crawl | Docs are already published as HTML |
Supported platforms
| Platform | Widget placement guide |
|---|---|
| Docusaurus | scripts in docusaurus.config.* |
| VitePress | head in .vitepress/config.* |
| MkDocs | extra_javascript in mkdocs.yml |
| Nextra | Next.js root layout |
| Mintlify | custom JavaScript in content root |
| Sphinx | html_js_files in conf.py |
| Read the Docs | underlying MkDocs or Sphinx config |
| Custom website | global layout or app shell |
Before any platform guide
- Create a project and copy the project ID.
- Add your docs hostname under Domains.
- Connect a source - GitHub repo sync or crawl.
The widget will not mount on hosts that are not allowlisted. Content must be indexed before the assistant can answer.
Widget attributes
All platforms share the same script attributes. Only data-project-id is required:
<script
async
src="https://cdn.knoku.com/widget.js"
data-project-id="YOUR_PROJECT_ID"
></script>Optional branding, consent, language, and trigger options: Widget reference.
Configure visually in the widget builder and paste the generated tag.
Verify
Open the deployed site. A working setup shows the widget and answers with links back to real doc URLs.
See Get started for the full first-run checklist.
Last updated on