mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
57 lines
1.9 KiB
Plaintext
57 lines
1.9 KiB
Plaintext
---
|
|
title: "Osano"
|
|
description: "Integrate Osano with your Mintlify documentation site to manage cookie consent banners, privacy preferences, and regulatory compliance."
|
|
keywords: ["Osano integration", "cookie consent manager", "GDPR compliance"]
|
|
boost: 3
|
|
---
|
|
|
|
Add [Osano](https://www.osano.com/) cookie consent to your docs with a [custom JavaScript file](/customize/custom-scripts#custom-javascript) in your repository.
|
|
|
|
## Setup
|
|
|
|
Create an `osano.js` file in your docs repository with the following content:
|
|
|
|
<CodeGroup>
|
|
|
|
```js Format
|
|
var script = document.createElement("script");
|
|
script.src = "OSANO_SCRIPT_URL";
|
|
document.head.appendChild(script);
|
|
```
|
|
|
|
```js Example
|
|
var script = document.createElement("script");
|
|
script.src = "https://cmp.osano.com/your-tenant-id/your-site-id/osano.js";
|
|
document.head.appendChild(script);
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
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`.
|
|
|
|
## Troubleshooting
|
|
|
|
<Accordion
|
|
title="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.
|
|
|
|
<Steps>
|
|
<Step title="Navigate to Managed Rules">
|
|
In your Osano dashboard, go to **Scripts** → **Managed Rules**.
|
|
</Step>
|
|
|
|
<Step title="Add Mintlify domain">
|
|
Add `.mintlify.app/` as a managed rule.
|
|
|
|
<Frame>
|
|
<img src="/images/integrations/osano-managed-rule.png" alt="Osano managed rule" />
|
|
</Frame>
|
|
|
|
<Info>
|
|
This ensures that all Mintlify-served assets (including images, stylesheets, and other documentation resources) are treated as essential and load even when Osano blocks uncategorized third-party content.
|
|
</Info>
|
|
</Step>
|
|
</Steps>
|
|
</Accordion>
|