Install guide: MkDocs (Material for MkDocs)

Add GetFoxChat to your MkDocs (Material for MkDocs) site

As of November 15, 2026, to add GetFoxChat to MkDocs (Material for MkDocs), in a theme override, overrides/main.html, inside the scripts block after {{ super() }} (MkDocs (Material for MkDocs)'s own guide, September 30, 2026). The video on this page shows GetFoxChat installed, tested and running in 4 minutes (watch it).

Before you start: Access to the site's source files and a rebuild and redeploy.

Watch it first

GetFoxChat being installed, tested and run on a real site▶ Watch how
Install, test and run GetFoxChat in 4 minutes

The line to add

Yours has your own site ID in place of YOUR_SITE_ID.

<script src="https://getfoxchat.com/widget.js" data-site-id="YOUR_SITE_ID" defer></script>

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

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.

Watch it take a visitor there

A visitor asks where Stripe connects. The GetFoxChat AI Operator scrolls to it and outlines it. Recorded on foxplug.com on 15 November 2026, signed out. Get the GIF

Find out what your visitors can't find

Type your website's address. GetFoxChat reads up to ten of your public pages and shows the GetFoxChat AI Operator answering three questions from them, with the page each answer came from. No account, nothing to install.

Like it? Press Put this on your site in the preview: you get a free account with the site already set up. Plans and what each includes: pricing.