Install guides (31)
Add Ishara to Mintlify
Add the feedback widget to your Mintlify docs with a small JavaScript file next to docs.json, which Mintlify loads on every page.
- Where it goes
- A
.jsfile next todocs.json - Allowed domains
- Your own domain, plus
your-project.mintlify.site - Time
- About 3 minutes
Steps
In Ishara, open Sites → your site → Install and copy the line under Add the line to your site. Your site’s key is already in it:
<script src="https://useishara.com/w.js" data-site="pk_…" defer></script>
In your docs repository, create
ishara.jsin the same folder asdocs.json, with this code. It adds the same line from JavaScript, and Mintlify loads every.jsfile in that folder on every page, so you don’t need to reference it anywhere:(function () { var s = document.createElement("script"); s.src = "https://useishara.com/w.js"; s.defer = true; s.dataset.site = "pk_…"; document.head.appendChild(s); })();Commit and push to deploy, or click Publish in the web editor.
Open your site. Back on the Install page, Check it’s live turns into The widget is live as soon as the widget loads. Then open the Reviewer link from the same page: only people who open it see Leave a note.
Good to know
- Don’t paste the line into an MDX page: Mintlify asks you to load third-party scripts from a
.jsfile instead. - Mintlify’s consent integrations (OneTrust, Transcend) only cover scripts loaded through
integrationsindocs.json, not your own.jsfiles. - Preview deployments run custom scripts too. If the widget doesn’t appear on one, open your browser’s console: the widget names the address it was blocked on; add that host to the site’s allowed domains.
Next
Once reviewers leave notes, your coding agent can apply them. The widget’s options (language, position, colour, launcher) are in the docs.