Skip to content

Document customScripts integration and loading strategies#4963

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/custom-scripts-docs-1774632452
Closed

Document customScripts integration and loading strategies#4963
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/custom-scripts-docs-1774632452

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Mar 27, 2026

Summary

  • Documents the integrations.customScripts field in docs.json, which lets users load external JavaScript files by URL on every page
  • Covers all three loading strategies: beforeInteractive, afterInteractive, and lazyOnload
  • The beforeInteractive strategy was recently added to support scripts that must execute before any user interaction, such as cookie consent banners

What changed

  • settings-integrations: Added a "Custom scripts" section with field descriptions and a code example
  • settings-reference: Added customScripts to the quick reference table and integrations property table
  • custom-scripts: Added a new section explaining how to load external scripts via docs.json, cross-referencing the integrations settings page

Note

Low Risk
Documentation-only changes that add schema/reference entries and usage guidance; low risk aside from potential confusion if the documented limits/validation diverge from implementation.

Overview
Documents the new integrations.customScripts docs.json field for loading external JavaScript on every page, including supported load strategy values (beforeInteractive, afterInteractive, lazyOnload) and an example configuration.

Updates the Integrations settings and docs.json schema reference to include customScripts (including the max of 20 scripts and src/strategy fields), and cross-links this approach with the existing Custom JavaScript guidance for repo-hosted scripts.

Written by Cursor Bugbot for commit b5da8e8. This will update automatically on new commits. Configure here.

@mintlify-development
Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🟡 Building Mar 27, 2026, 5:27 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Mar 27, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Mar 27, 2026, 5:30 PM

@ethanpalm
Copy link
Copy Markdown
Collaborator

Closing as duplicate of #4981. That PR is more recent and covers the same customScripts documentation. The most comprehensive version will be reviewed separately.

@ethanpalm ethanpalm closed this Mar 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant