Script tag
Add GitBook Assistant to any website with a simple script tag
Last updated
Was this helpful?
πΊπΈ English
Add GitBook Assistant to any website with a simple script tag
Last updated
Was this helpful?
Was this helpful?
The quickest way to add GitBook Assistant to your website or app is by adding it through a script tag. Every docs site in GitBook includes a ready-to-use script for embedding the Assistant as a widget.
Get your embed script URL
Navigate to your docs site's Settings β AI & MCP tab and copy the script URL. It will look like: https://docs.company.com/~gitbook/embed/script.js
Add the script tag to your HTML
Place this code in your HTML <head> or before the closing </body> tag:
<script src="https://docs.company.com/~gitbook/embed/script.js"></script>
<script>
window.GitBook("show");
</script>Replace the docs URL
Update docs.company.com with your actual docs site URL.
Test the widget
Load your page. The Assistant widget should appear in the bottom-right corner.
Optionally configure the Assistant
Add customization options before calling show():
<script src="https://docs.company.com/~gitbook/embed/script.js"></script>
<script>
window.GitBook("configure", {
welcomeMessage: "Welcome! How can I help you today?",
suggestions: [
"How do I get started?",
"What are the pricing plans?",
"How do I reset my password?",
],
});
window.GitBook("show");
</script>Control widget visibility
Use the API to show, hide, open, or close the Assistant:
<script>
// Show the widget
window.GitBook("show");
// Hide the widget
window.GitBook("hide");
// Open the Assistant panel
window.GitBook("open");
// Close the Assistant panel
window.GitBook("close");
</script>Load dynamically (optional)
For authenticated docs or conditional loading, inject the script at runtime:
<script>
function loadGitBookAssistant() {
var script = document.createElement("script");
script.src = "https://docs.company.com/~gitbook/embed/script.js";
script.async = true;
script.onload = function () {
window.GitBook("show");
};
document.head.appendChild(script);
}
// Load when ready
loadGitBookAssistant();
</script>Verify the setup
Open your browser console and type window.GitBook to confirm the API is available.
siteURL
string
Yes*
Derived from script URL
Your GitBook docs site URL. Only required when using configure() explicitly.
welcomeMessage
string
No
null
Custom welcome message shown when the Assistant opens.
suggestions
string[]
No
[]
Array of suggested questions displayed to users.
buttons
object[]
No
[]
Custom buttons in the Assistant header. Each button has label, icon, and onClick properties.
API Methods (via window.GitBook()):
'show'
config?
Show the Assistant widget. Optionally pass a config object.
'hide'
None
Hide the widget without unloading it.
'open'
None
Open the Assistant panel.
'close'
None
Close the Assistant panel.
'toggle'
None
Toggle the panel open/closed.
'configure'
config
Set configuration options (welcomeMessage, suggestions, buttons, tools).
'unload'
None
Completely remove the widget from the page.
Script URL is incorrect β Ensure you're using your actual docs URL, not the example docs.company.com.
Calling GitBook before script loads β Wrap API calls in script.onload or place them after the script tag.
Authenticated docs not accessible β If your docs require sign-in, the Assistant cannot access content unless you provide the gitbook-visitor-token. See Using with authenticated docs.
CORS or CSP errors β Ensure your site's Content Security Policy allows loading scripts and iframes from your GitBook domain.
Widget not visible β Check z-index conflicts with other elements on your page. The widget uses a high z-index by default.