Custom Scripts

Inject custom JavaScript into your published documentation site. Use custom scripts for analytics providers not covered by built-in integrations, consent banners, A/B testing tools, or any custom functionality.

Prerequisites

• A documentation project with publishing access

• A .js or .mjs script file added to your documentation project

Configure custom scripts from the Editor

You can manage custom scripts directly from the Editor without editing JSON.

Configure custom scripts via documentation.json

If you manage configuration in version control, add scripts directly to documentation.json:

{
  "scripts": [
    { "src": "scripts/consent-banner.js" },
    { "src": "scripts/custom-tracking.mjs" }
  ]
}

Each entry in the scripts array has a single property:

Script file requirements

• Files must use a .js or .mjs extension.
• Paths are relative to your project root (for example, scripts/analytics.js).
• Maximum file size is 5 MB.
• The file must exist in your documentation project before you can reference it.

Security considerations

Custom scripts execute in your readers' browsers with full page access.

• Only add scripts you trust and have reviewed.

• Audit script contents periodically, especially if they interact with user data or external services.

Troubleshooting

Script not loading: Verify the file exists in your project and uses a .js or .mjs extension. Check the browser developer console for syntax errors.

Script conflicts: If multiple scripts interfere with each other, try reordering them in the scripts array. Scripts load in the order they appear in the configuration.

Changes not visible: Custom script changes require publishing. Check that you have published after making edits.

What's next

• Analytics and chat integrations — zero-code setup for popular analytics and chat tools

• Site configuration reference — full documentation.json reference