Integration

Use integrations in heyo-docs.config.ts to add supported third-party services to every documentation page. Integrations are grouped by purpose so consent tooling can load before analytics and support widgets.

The current release supports Adobe Analytics, Intercom, and Osano. Configure only the providers you need; omitted categories and providers remain empty.

Configure integrations

Add providers below their purpose-specific category:

import { heyoDocs } from "@heyo-sh/heyo-docs";

export default heyoDocs({
  content: "content",
  integrations: {
    analytics: {
      adobe: {
        launchUrl:
          "https://assets.adobedtm.com/launch-EN93497c30fdf0424eb678d5f4ffac66dc.min.js",
      },
    },
    support: {
      intercom: {
        appId: "abc123",
      },
    },
    consent: {
      osano: {
        scriptUrl: "https://cmp.osano.com/your-tenant-id/your-site-id/osano.js",
      },
    },
  },
});

Every category is optional. The normalized configuration always contains the following empty structure when no provider is configured:

integrations: {
  analytics: {},
  support: {},
  consent: {},
}

Heyo Docs validates each configured provider and rejects unknown properties. This keeps the configuration explicit as support grows.

Framework support

The official templates render configured integrations from the document root in every supported framework:

No framework-specific integration settings are required. Keep provider configuration in heyo-docs.config.ts; the selected template owns the framework-specific script markup.

Analytics

Adobe Analytics

Configure Adobe Experience Platform Launch with its production launch URL:

export default heyoDocs({
  content: "content",
  integrations: {
    analytics: {
      adobe: {
        launchUrl: "https://assets.adobedtm.com/launch-YOUR-ID.min.js",
      },
    },
  },
});

Find the URL in Adobe Experience Platform Data Collection: open the Launch property, select Environments, and copy the script URL from the production environment. Heyo Docs loads that script asynchronously.

Support

Intercom

Add the public app ID for your Intercom workspace:

export default heyoDocs({
  content: "content",
  integrations: {
    support: {
      intercom: {
        appId: "abc123",
      },
    },
  },
});

Heyo Docs adds Intercom's standard browser bootstrap snippet to the document head. The widget script loads asynchronously after the browser has loaded the page.

Consent

Osano

Use the Osano script URL generated for your site:

export default heyoDocs({
  content: "content",
  integrations: {
    consent: {
      osano: {
        scriptUrl: "https://cmp.osano.com/your-tenant-id/your-site-id/osano.js",
      },
    },
  },
});

Osano is placed before analytics and support scripts and loads synchronously. This gives the consent manager the first opportunity to apply its policy before other third-party services are requested. If you use Osano's Strict mode, mark the domains required by your documentation assets as essential in your Osano managed rules.

Keep credentials safe

Integration settings become part of the browser-facing documentation site. Only add public identifiers and public script URLs. Never add private API keys, server credentials, or user data to heyo-docs.config.ts.

After changing integrations, run a production build and verify the consent banner, analytics requests, and support widget in a browser:

bun run typecheckbun run build