Add a chat widget to Mintlify docs

Installation steps

1. 1

   Prepare

   Copy the public site key shown for the docs hostname in MivoChat Install.

2. 2

   Configure

   In the docs repository, create or update the custom JavaScript file used by your Mintlify configuration.

3. 3

   Publish

   Add this JavaScript to that file: `(function(){var s=document.createElement('script');s.src='https://mivochat.app/widget.js';s.async=true;s.dataset.site='YOUR_SITE_KEY';document.head.appendChild(s);})();`.

4. 4

   Verify

   Deploy the docs, allow the published origin, and test a docs question plus team handoff.

Check the current Mintlify setup

Mintlify configuration evolves. Follow the custom JavaScript mechanism documented for your repository version, and keep the MivoChat loader in that supported file rather than injecting it into generated page content.

For current code-based projects, check the repository's `docs.json` before editing configuration; older projects may still have `mint.json`. Do not add a guessed `javascript` field because Mintlify validates its configuration schema. If the dashboard or current docs do not expose a supported global script route for your plan, link readers to a chat-enabled product or marketing page instead.

Test the deployed documentation

Ask a question about an API key, a webhook secret, and an undocumented behavior. Check source grounding and ensure a teammate can reply to the last question.

Use the dashboard's Editor for a content check, then verify the deployment on the public `mintlify.app` preview or configured custom domain. Confirm a docs page is accessible without editor credentials, check the browser Console for script or CSP errors, and add the exact docs hostname in Install settings → Allowed websites. A preview hostname and a custom docs domain are separate origins, so validate each one the team expects to support.

Before you change the setup

repository write access, a working docs preview, a public widget key, and the production docs hostname

the custom JavaScript file and configuration supported by that Mintlify project version

Mintlify's supported configuration can change; avoid assuming a config key copied from another repository is valid

Test the support boundary

• What scopes does the create-token endpoint need?
• What should I inspect when webhook delivery times out?
• Can the assistant guess behavior missing from these docs?

Related guidance

Keep a small regression list for key Mintlify pages after config upgrades, since custom script loading is part of the deployed docs shell.

Frequently asked questions