Add GetFoxChat to your MkDocs (Material for MkDocs) site

Watch it first

▶ Watch how

The line to add

Yours has your own site ID in place of YOUR_SITE_ID.

On MkDocs (Material for MkDocs), this is what goes in overrides/main.html:

{% extends "base.html" %}
{% block scripts %}
  {{ super() }}
  <script src="https://getfoxchat.com/widget.js" data-site-id="YOUR_SITE_ID" defer></script>
{% endblock %}

How do you add GetFoxChat to MkDocs (Material for MkDocs), step by step?

1. In GetFoxChat, open the install step for your site and copy your snippet. It already has your site ID in it. No account yet? Create one free.
2. In mkdocs.yml, under theme, set custom_dir: overrides and create an overrides folder next to mkdocs.yml. source
3. Create overrides/main.html (or open it if it already exists). source
4. Add {% extends "base.html" %} and a {% block scripts %} that calls {{ super() }} first, then the GetFoxChat line, then {% endblock %}. source
5. Replace YOUR_SITE_ID with your site ID, then rebuild with mkdocs build and redeploy. source
6. Back in GetFoxChat, press Check my site. The chat switches on once GetFoxChat finds the snippet on your live pages.

MkDocs (Material for MkDocs)'s own guide: Material for MkDocs: Customization. Checked 2026-09-30; if MkDocs (Material for MkDocs) renames a menu, its guide has the current wording.

MkDocs (Material for MkDocs) gotchas

• extra_javascript in mkdocs.yml only accepts path, type, async and defer, so it cannot set the data-site-id attribute; use the theme override instead. source
• Theme overrides need Material for MkDocs installed via pip and named in mkdocs.yml; they do not work with a theme cloned from git. source
• With instant loading turned on, moving between pages does not refresh the browser page, so test the chat after clicking between pages. source

How do you remove it later?

Delete the GetFoxChat line from overrides/main.html (and the scripts block if it held nothing else), then rebuild and redeploy.

Steps are for the Material for MkDocs theme. Plain MkDocs themes also support custom_dir, but block names differ per theme.