Skip to main content
Mintlify

Search documentation

Type to search this documentation.

On this pageOverview

Osano

Integrate Osano with your Mintlify documentation site to manage cookie consent banners, privacy preferences, and regulatory compliance.

Add Osano cookie consent to your docs with a custom JavaScript file in your repository.

Create an osano.js file inside your content directory with the following content.

Format
var script = document.createElement("script");
script.src = "OSANO_SCRIPT_URL";
document.head.appendChild(script);
Example
var script = document.createElement("script");
script.src = "https://cmp.osano.com/your-tenant-id/your-site-id/osano.js";
document.head.appendChild(script);

Replace OSANO_SCRIPT_URL with your Osano script URL. Your script URL is the src value in the code snippet that Osano generates. Your script URL always starts with https://cmp.osano.com/ and ends with /osano.js.

Mintlify includes any .js file inside your content directory on every page of your site, so you don't need to register osano.js in docs.json.

After you deploy, open your site in a private or incognito window and confirm the Osano consent banner appears. If it doesn't, check the browser console for errors loading osano.js and confirm the script URL matches the one from your Osano dashboard.

Pages not loading with Strict compliance mode

If your documentation pages aren't loading properly when using Osano's Strict compliance mode, you'll need to add Mintlify's domain to your allowlist to allow images and other assets to load.

  1. Navigate to Managed Rules

    In your Osano dashboard, go to Scripts → Managed Rules.

  2. Add Mintlify domain

    Add .mintlify.site/ as a managed rule.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu