Documentation Platforms

MkDocs

AI answers for MkDocs and Material for MkDocs sites

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.

Integration

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 support

Index MkDocs sites with multiple language variants. Kelu tracks each language path separately.

Deploy hook integration

Trigger a Kelu sync from your CI/CD pipeline after mkdocs build and deploy to keep the index current.

Setup

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 the Kelu widget script to your MkDocs custom_html overrides (overrides/main.html) to embed AI chat.

Related integrations

Mintlify

Kelu crawls your Mintlify docs site, keeps it in sync, and answers user questions with citations.

View details

Docusaurus

Crawl, sync, and embed AI chat on any Docusaurus v2 or v3 documentation site.

View details

GitBook

Index your GitBook spaces and let users ask questions with full citations back to source pages.

View details

MkDocs — Frequently Asked Questions

Common questions about connecting Kelu to MkDocs.

Override the main.html template in your MkDocs project's overrides directory and add the Kelu widget script tag inside the extra_javascript block or directly in the HTML. The widget will appear on every page of your MkDocs site.

Yes. Kelu can index each language variant of your MkDocs site separately and track them as distinct sources. This ensures users asking questions in a specific language context get answers from the correct language version of your docs.

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.

Add a curl call to the Kelu knowledge base sync API endpoint in your CI/CD pipeline after mkdocs build completes. Kelu performs an incremental sync, only re-processing pages whose content has changed since the last index.

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.

Ready to connect MkDocs?

Start free. No credit card required. Connect your first integration in under 5 minutes.

Get started free