What is MkDocs?
MkDocs is a Python-based static site generator for project documentation. The Material for MkDocs theme is widely used in open-source and enterprise projects to produce professional documentation from Markdown files.
How Kelu works with MkDocs
Everything you can do once the integration is connected.
Sitemap-aware discovery
Kelu reads the MkDocs-generated sitemap.xml to discover all pages, including those in nested nav sections.
Clean content extraction
The crawler strips Material for MkDocs's navigation, sidebar, and footer, extracting only the documentation content for indexing.
Multi-language sites
Add each language variant of your MkDocs site as its own source. To keep languages apart, give each its own knowledge base and widget.
Automatic re-crawls
Kelu re-crawls your MkDocs site every 24 hours. Click Sync Now after a deploy to refresh the index at once.
How to set it up
- 1
Enter your MkDocs site URL in Kelu. The crawler will use the sitemap.xml to index all pages.
- 2
Review the crawled page list and configure any URL exclusions for pages you do not want indexed.
- 3
Add a small js/kelu-widget.js file that loads the Kelu widget script, and list it under extra_javascript in mkdocs.yml to embed AI chat.
Related integrations
Got questions?
MkDocs — Frequently Asked Questions
Common questions about connecting Kelu to MkDocs.
Add a small docs/js/kelu-widget.js file that creates the widget's script tag, and list it under extra_javascript in mkdocs.yml. It works with any theme, including Material for MkDocs, and the widget will appear on every page of your MkDocs site.
Yes. Add each language variant of your MkDocs site as its own source. Kelu does not pick a language version for a question by itself. To answer each language only from its own pages, put each in its own knowledge base with its own widget, or, on the Enterprise plan, in its own source group.
Yes. Kelu's crawler identifies and strips navigation sidebars, headers, and footers from Material for MkDocs pages, indexing only the actual documentation content. This prevents navigation labels from polluting search results.
Kelu re-crawls your site every 24 hours, only re-processing pages whose content has changed since the last index. For an immediate update after a deploy, click Sync Now on the source.
Yes. Configure URL exclusion patterns in your Kelu source settings to skip pages you do not want in the knowledge base. You can also use MkDocs's exclude_docs option to prevent certain files from appearing in the generated sitemap.