Ask0 logoAsk0
Integrations

MkDocs Integration

Integrate Ask0's AI search into your MkDocs documentation. Add intelligent chat assistance to MkDocs sites with Material theme.

Add Ask0 to your MkDocs documentation site.

Installation

Override Template

Create a custom template:

docs/overrides/main.html
{% extends "base.html" %}

{% block scripts %}
  {{ super() }}
  <script
    src="https://assets.ask0.ai/scripts/ask.js"
    data-project-id="{{ config.extra.ask0_project_id }}"
  ></script>
{% endblock %}

Configuration

mkdocs.yml
theme:
  name: material
  custom_dir: docs/overrides

extra:
  ask0_project_id: YOUR_PROJECT_ID

Material Theme

For MkDocs Material theme:

mkdocs.yml
extra_javascript:
  - https://assets.ask0.ai/scripts/ask.js

extra:
  ask0:
    project_id: YOUR_PROJECT_ID
    position: bottom-right
    theme: auto

Then add initialization:

docs/javascripts/ask0-init.js
document.addEventListener('DOMContentLoaded', function() {
  const script = document.querySelector('[src*="ask0.ai"]');
  if (script) {
    script.setAttribute('data-project-id', 'YOUR_PROJECT_ID');
  }
});

MkDocs Tips:

  • Use template overrides for custom HTML
  • Store project ID in mkdocs.yml extra section
  • Works with Material theme
  • Test with mkdocs serve before deploying

Next Steps