> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cookiechimp.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Add CookieChimp to your website in under 5 minutes.

<Steps>
  <Step title="Add our JS code">
    Add your website's CookieChimp JS snippet in the `<head>` tag of your HTML:

    <Info>
      The CookieChimp script needs to be added at the top of the `<head>` section, so that it can run first, in order to ensure other scripts are only run based on consent.
      If other scripts are added before, they may set cookies and other storage items before consent is granted.
    </Info>

    ```html theme={null}
    <script src="https://cookiechimp.com/widget/abc123.js"></script>
    ```

    You need to replace `abc123` with your website's unique CookieChimp ID.
  </Step>

  <Step title="Block Scripts & Cookies">
    To ensure compliance with GDPR regulations, it's crucial not only to display a consent banner but also to actively block all non-essential scripts and cookies until the user has given explicit consent.
    For comprehensive instructions on how to effectively manage and block scripts and cookies, please refer to our [Scripts Management Section](/docs/block-scripts-cookies/script-attributes).
  </Step>

  <Step title="Allow users to update their preferences">
    CookieChimp provides a floating privacy icon (Privacy Trigger) that allows users to manage their cookie preferences at any time.
    You can enable this in the banner settings.

    Optionally, you can open the preferences modal with a custom link or button by adding a button with the data attribute `data-cc="show-preferencesModal"`:

    ```html theme={null}
    <button type="button" data-cc="show-preferencesModal">
      Manage cookie preferences
    </button>
    ```
  </Step>
</Steps>

## Are there platform-specific guides?

Yes — pick the guide that matches your stack for tailored instructions.

### Plain HTML

<CardGroup cols={2}>
  <Card title="HTML" icon="code" href="/docs/installation/html">Add the snippet to a static HTML site — also a useful reference for understanding how CookieChimp works under the hood.</Card>
</CardGroup>

### JavaScript frameworks

<CardGroup cols={2}>
  <Card title="Next.js" icon="react" href="/docs/installation/nextjs">App Router and Pages Router with `next/script`.</Card>
  <Card title="React (Vite / CRA)" icon="react" href="/docs/installation/react">Plain React apps with React Router.</Card>
  <Card title="Remix" icon="react" href="/docs/installation/remix">Server-rendered React with client navigation.</Card>
  <Card title="Nuxt" icon="vuejs" href="/docs/installation/nuxt">Vue framework with SSR and client routing.</Card>
  <Card title="Angular" icon="angular" href="/docs/installation/angular">Standalone or NgModule-based apps.</Card>
  <Card title="Astro" icon="rocket" href="/docs/installation/astro">Static sites, with or without View Transitions.</Card>
  <Card title="SvelteKit" icon="code" href="/docs/installation/sveltekit">SvelteKit's `afterNavigate` pattern.</Card>
  <Card title="JS & SPAs (catch-all)" icon="code" href="/docs/installation/single-page-applications">Generic SPA setup if your framework isn't above.</Card>
</CardGroup>

### CMS, eCommerce & tag managers

<CardGroup cols={2}>
  <Card title="WordPress" icon="wordpress" href="/docs/installation/wordpress">Official plugin with WP Consent API support.</Card>
  <Card title="Shopify" icon="shopify" href="/docs/installation/shopify">Add the snippet to `theme.liquid`.</Card>
  <Card title="Google Tag Manager" icon="google" href="/docs/installation/google-tag-manager">Direct HTML or via GTM's Consent Initialization trigger.</Card>
</CardGroup>

### Website builders

<CardGroup cols={2}>
  <Card title="Webflow" icon="webflow" href="/docs/installation/webflow">Custom Code in Project Settings.</Card>
  <Card title="Framer" icon="framer" href="/docs/installation/framer">Site Settings → Custom Code → Head.</Card>
  <Card title="Squarespace" icon="squarespace" href="/docs/installation/squarespace">Header Code Injection.</Card>
  <Card title="Wix" icon="globe" href="/docs/installation/wix">Custom Code on Wix Premium plans.</Card>
  <Card title="Ghost" icon="ghost" href="/docs/installation/ghost">Site Header in Code Injection.</Card>
  <Card title="Carrd" icon="credit-card" href="/docs/installation/carrd">Embed widget set to Head (Carrd Pro).</Card>
  <Card title="Duda" icon="layout-template" href="/docs/installation/duda">Site-Wide Code → Header.</Card>
  <Card title="Bubble" icon="circle-dot" href="/docs/installation/bubble">SEO/metatags → Script/meta tags in header.</Card>
  <Card title="Weebly" icon="globe" href="/docs/installation/weebly">SEO → Header Code (paid plans).</Card>
  <Card title="Hostinger" icon="server" href="/docs/installation/hostinger">Integrations → Custom code.</Card>
</CardGroup>

## What if the banner doesn't show?

* Check if the domain is allowed in the Settings page on our platform.
* If the widget doesn't display, ensure there are no conflicts with other scripts or styles on your website.
* Clear your browser cache and cookies, then reload the website.
* Enable "Debug mode" from our platform and open JS console to check for any errors.

## How do I get help?

<Note>
  If you encounter any issues or require further assistance, please reach out to us via our chat.
</Note>
