Install Site Rep Docs Mode

Docs Mode adds a compact Ask AI launcher, a configurable hotkey, starter questions, and an expandable Used N sources drawer. It still answers only from approved sources and records every visitor answer or lead against a conversation ID.

Use the canonical single-script snippet when the host supports custom JavaScript:

<script src="https://siterep.net/widget.js" defer data-bot-id="YOUR_BOT_ID" data-public-key="YOUR_PUBLIC_WIDGET_KEY" data-api-base="https://siterep.net" data-theme="#1f8f5f" data-mode="docs" data-hotkey="mod+k"></script>

Before you start, get the real values from your dashboard:

• Start free with 50 source-backed answers and no card, or sign in to an existing workspace. The dashboard shows your bot ID, public widget key, allowed install domains, and a ready-to-copy snippet with your values already filled in.
• Replace `YOUR_BOT_ID` and `YOUR_PUBLIC_WIDGET_KEY` with the dashboard values before publishing. A snippet left with placeholders stays dormant.
• Add the docs domain to the Site Rep allowed-domain list. Site Rep records install proof only after the published domain sends one widget ping and one test lead or cited answer comes through the widget.

Never put owner dashboard keys, session tokens, payment secrets, source files, or private docs content into the snippet. The public widget key is safe to expose, but the allowed-domain lock must still match the live site.

Mintlify

Status: supported.

Where to paste: Add a custom JavaScript file to the Mintlify docs repo so it runs across docs pages.

Minimal snippet:

const script = document.createElement("script");
script.src = "https://siterep.net/widget.js";
script.defer = true;
script.dataset.botId = "YOUR_BOT_ID";
script.dataset.publicKey = "YOUR_PUBLIC_WIDGET_KEY";
script.dataset.apiBase = "https://siterep.net";
script.dataset.mode = "docs";
script.dataset.hotkey = "mod+k";
document.head.appendChild(script);

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Mintlify custom scripts run globally after the page is interactive, so test search, navigation, dark mode, and mobile.
• Lock the docs domain in Site Rep before expecting install proof.
• Import the docs sitemap or approved docs URLs into the source manifest before launch.

Docusaurus

Status: supported.

Where to paste: Add a script object to docusaurus.config.js in the site config.

Minimal snippet:

scripts: [
  {
    src: "https://siterep.net/widget.js",
    defer: true,
    "data-bot-id": "YOUR_BOT_ID",
    "data-public-key": "YOUR_PUBLIC_WIDGET_KEY",
    "data-api-base": "https://siterep.net",
    "data-mode": "docs",
    "data-hotkey": "mod+k",
  },
],

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• If the docs site has a strict Content Security Policy, allow script-src and connect-src for https://siterep.net.
• Use the production docs hostname as the allowed install domain.
• Validate after a production build, not only local dev.

GitBook

Status: not-directly-installable.

Where to paste: Hosted GitBook does not directly support arbitrary custom HTML, CSS, or JavaScript.

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Hosted GitBook is not directly installable with the widget today.
• Use Site Rep to ingest public GitBook pages as approved sources.
• Install the widget on a wrapper site, marketing site, app shell, or another host that supports custom scripts.
• Do not promise hosted GitBook widget install unless GitBook adds a supported custom-code path.

Static docs

Status: supported.

Where to paste: Paste the canonical script in the shared layout or footer before the closing body tag.

Minimal snippet:

<script src="https://siterep.net/widget.js" defer data-bot-id="YOUR_BOT_ID" data-public-key="YOUR_PUBLIC_WIDGET_KEY" data-api-base="https://siterep.net" data-theme="#1f8f5f" data-mode="docs" data-hotkey="mod+k"></script>

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Use docs mode for docs sites and site mode for marketing pages.
• If CSP is enabled, allow script-src and connect-src for https://siterep.net.
• Publish, open the live page once, then confirm the install ping in Site Rep.

Webflow

Status: supported.

Where to paste: Use Site settings Footer code for site-wide install, or Page settings before body for a docs-only page.

Minimal snippet:

<script src="https://siterep.net/widget.js" defer data-bot-id="YOUR_BOT_ID" data-public-key="YOUR_PUBLIC_WIDGET_KEY" data-api-base="https://siterep.net" data-theme="#1f8f5f" data-mode="docs" data-hotkey="mod+k"></script>

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Publish the Webflow site before expecting Site Rep to see the install.
• If a fixed cookie banner or chat tool overlaps the widget, move that tool or use Docs Mode's compact Ask AI launcher.
• Keep the Webflow production domain in the allowed-domain list.

Framer

Status: supported.

Where to paste: Use Project Settings, Custom Code, and place the script where Framer loads site-wide body code.

Minimal snippet:

<script src="https://siterep.net/widget.js" defer data-bot-id="YOUR_BOT_ID" data-public-key="YOUR_PUBLIC_WIDGET_KEY" data-api-base="https://siterep.net" data-theme="#1f8f5f" data-mode="docs" data-hotkey="mod+k"></script>

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Choose a site-wide placement for docs collections; use page-level code only for a limited rollout.
• Publish before checking the Site Rep install receipt.
• Test route changes because Framer navigation can keep pages alive without a full reload.

Generic sites

Status: supported.

Where to paste: Paste the canonical script before the closing body tag on every page that should show Ask AI.

Minimal snippet:

<script src="https://siterep.net/widget.js" defer data-bot-id="YOUR_BOT_ID" data-public-key="YOUR_PUBLIC_WIDGET_KEY" data-api-base="https://siterep.net" data-theme="#1f8f5f" data-mode="docs" data-hotkey="mod+k"></script>

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Use data-mode="docs" for docs pages and omit it for the normal site widget.
• Allowed domains are exact origins, with apex/www twins accepted.
• A valid install needs a live-domain widget ping and one test lead or cited answer.

WordPress

Status: supported.

Where to paste: Use the Site Rep WordPress plugin or a trusted header/footer script plugin.

Minimal snippet:

<script src="https://siterep.net/widget.js" defer data-bot-id="YOUR_BOT_ID" data-public-key="YOUR_PUBLIC_WIDGET_KEY" data-api-base="https://siterep.net" data-theme="#1f8f5f" data-mode="docs" data-hotkey="mod+k"></script>

Recommended validation:

• Confirm the docs or site domain is in Site Rep allowed domains.
• Confirm the approved source manifest includes docs pages, sitemap, llms.txt links, PDFs, or manual uploads as appropriate.
• Publish the host, open the live page once, ask a cited question, expand Used N sources, and submit one test lead.
• Check for overlay conflicts on desktop and mobile.

Troubleshooting:

• Prefer the Site Rep WordPress plugin when available because it keeps the snippet in one place.
• If caching is enabled, purge cache after adding the script.
• Do not paste owner access keys or private dashboard links into WordPress.