Document customScripts integration and loading strategies#4963
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Document customScripts integration and loading strategies#4963mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
integrations.customScriptsfield indocs.json, which lets users load external JavaScript files by URL on every pagebeforeInteractive,afterInteractive, andlazyOnloadbeforeInteractivestrategy was recently added to support scripts that must execute before any user interaction, such as cookie consent bannersWhat changed
customScriptsto the quick reference table and integrations property tabledocs.json, cross-referencing the integrations settings pageNote
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.customScriptsdocs.jsonfield for loading external JavaScript on every page, including supported loadstrategyvalues (beforeInteractive,afterInteractive,lazyOnload) and an example configuration.Updates the Integrations settings and
docs.jsonschema reference to includecustomScripts(including the max of 20 scripts andsrc/strategyfields), 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.