🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Add Mintlify integration and update settings
Bill Yang844b984c31bd
diff --git a/.claude/settings.local.json b/.claude/settings.local.jsonindex ce0e01c10..c5e4368c4 100644--- a/.claude/settings.local.json+++ b/.claude/settings.local.json@@ -6,7 +6,10 @@"Bash([ -d hooks ])","WebFetch(domain:carto.com)","Bash(npx tsc:*)",- "Bash(npm run lint)"+ "Bash(npm run lint)",+ "WebFetch(domain:www.mintlify.com)",+ "WebSearch",+ "WebFetch(domain:github.com)"],"deny": [],"ask": []diff --git a/client/src/app/[site]/components/Header/NoData.tsx b/client/src/app/[site]/components/Header/NoData.tsxindex ca1e72360..37da67810 100644--- a/client/src/app/[site]/components/Header/NoData.tsx+++ b/client/src/app/[site]/components/Header/NoData.tsx@@ -21,6 +21,7 @@ import {SiWix,SiWoocommerce,SiWordpress,+ SiMintlify,} from "@icons-pack/react-simple-icons";import React from "react";import { useGetSite, useSiteHasData } from "../../../../api/admin/sites";@@ -190,6 +191,12 @@ export function NoData() {description=""href="https://rybbit.io/docs/guides/laravel"/>+ <Card+ icon={<SiMintlify className="w-5 h-5" />}+ title="Mintlify"+ description=""+ href="https://rybbit.io/docs/guides/mintlify"+ /><Cardicon={<SiShopify className="w-5 h-5" />}title="Shopify"diff --git a/docs/content/docs/guides/meta.json b/docs/content/docs/guides/meta.jsonindex ad659a673..dbc7161e3 100644--- a/docs/content/docs/guides/meta.json+++ b/docs/content/docs/guides/meta.json@@ -11,6 +11,7 @@"hugo","jekyll","laravel",+ "mintlify","react","shopify","squarespace",diff --git a/docs/content/docs/guides/mintlify.mdx b/docs/content/docs/guides/mintlify.mdxnew file mode 100644index 000000000..e1dcc5e30--- /dev/null+++ b/docs/content/docs/guides/mintlify.mdx@@ -0,0 +1,126 @@+---+title: Mintlify+description: Integrate Rybbit Analytics with your Mintlify documentation site+---++import { Steps, Step } from 'fumadocs-ui/components/steps';+import { Callout } from 'fumadocs-ui/components/callout';+++This guide explains how to integrate Rybbit with your Mintlify documentation site for analytics tracking. Mintlify uses a file-based approach for custom scripts where any JavaScript file in your content directory is automatically included on every documentation page.++## How to Add Rybbit to Your Mintlify Docs++Mintlify allows you to add custom JavaScript files to your documentation by placing `.js` files inside your content directory. These files will be automatically included on every page.++<Steps>+<Step>+### Retrieve Your Tracking Script Details++Navigate to your Rybbit dashboard to obtain your **Site ID**. The script source will be `https://app.rybbit.io/api/script.js` (or your self-hosted URL if applicable).+</Step>++<Step>+### Create a Custom JavaScript File++Create a new JavaScript file in your Mintlify content directory (typically where your `.mdx` files are located). You can name it something descriptive like `rybbit-analytics.js`.++```javascript filename="rybbit-analytics.js"+// Rybbit Analytics Integration+(function() {+ // Create the script element+ const script = document.createElement('script');+ script.src = 'https://app.rybbit.io/api/script.js';+ script.async = true;+ script.defer = true;+ script.setAttribute('data-site-id', 'YOUR_SITE_ID'); // Replace with your actual Site ID++ // Append the script to the document head+ document.head.appendChild(script);+})();+```++Make sure to replace `YOUR_SITE_ID` with your actual Site ID from your Rybbit dashboard.++If you're self-hosting Rybbit, replace `https://app.rybbit.io/api/script.js` with your self-hosted URL (e.g., `https://your-domain.com/api/script.js`).+</Step>++<Step>+### Verify Installation++After deploying your Mintlify documentation site, open your Rybbit dashboard to check if data is being received. You can also inspect your browser's network tab to confirm that `script.js` is loaded on your pages and the Rybbit tracking requests are being sent.++Look for:+- The `script.js` file being loaded in the Network tab+- POST requests to your Rybbit analytics endpoint (e.g., `/api/event`)+</Step>+</Steps>++<Callout type="info">+ **Page View Tracking**: Mintlify documentation sites are Single Page Applications (SPAs). Rybbit's tracking script is designed to automatically detect route changes in SPAs and track them as page views. The default configuration should work out of the box without any additional setup.+</Callout>++## Advanced Configuration++### Custom Script Attributes++You can customize the Rybbit script behavior by adding data attributes to the script tag:++```javascript filename="rybbit-analytics.js"+(function() {+ const script = document.createElement('script');+ script.src = 'https://app.rybbit.io/api/script.js';+ script.async = true;+ script.defer = true;+ script.setAttribute('data-site-id', 'YOUR_SITE_ID');++ // Optional: Customize debounce duration (default: 500ms)+ script.setAttribute('data-debounce', '1000');++ // Optional: Add custom skip patterns for certain URLs+ script.setAttribute('data-skip-patterns', JSON.stringify(['/admin/*', '/internal/*']));++ // Optional: Add custom mask patterns for sensitive data+ script.setAttribute('data-mask-patterns', JSON.stringify(['password', 'token']));++ document.head.appendChild(script);+})();+```++Available script attributes:+- `data-site-id` (required): Your Rybbit site ID+- `data-debounce`: Debounce duration in milliseconds for tracking events (default: 500)+- `data-skip-patterns`: JSON array of URL patterns to skip tracking+- `data-mask-patterns`: JSON array of patterns to mask in tracked data+- `data-replay-batch-size`: Number of session replay events to batch before sending (default: 250)+- `data-replay-batch-interval`: Interval in milliseconds to send session replay batches (default: 5000)++## Custom Event Tracking++You can track custom events in your Mintlify documentation using the global `window.rybbit` API. This is useful for tracking specific user interactions like button clicks, downloads, or form submissions.++### Tracking Custom Events in MDX++Since Mintlify supports MDX, you can add inline event handlers to track custom events:++```mdx+<button+ onClick={() => {+ if (typeof window !== 'undefined' && window.rybbit) {+ window.rybbit.event('download_clicked', {+ file: 'getting-started-guide.pdf',+ section: 'introduction'+ });+ }+ }}+ className="px-4 py-2 bg-blue-600 text-white rounded hover:bg-blue-700"+>+ Download Guide+</button>+```+## Related Resources++- [Rybbit Script Configuration](/docs/script)+- [Custom Event Tracking](/docs/track-events)+- [Mintlify Documentation](https://mintlify.com/docs)+- [Mintlify Custom Scripts](https://www.mintlify.com/docs/customize/custom-scripts)diff --git a/docs/content/docs/index.mdx b/docs/content/docs/index.mdxindex 603bf0a91..d16019889 100644--- a/docs/content/docs/index.mdx+++ b/docs/content/docs/index.mdx@@ -15,7 +15,8 @@ import {SiHugo,SiJekyll,SiLaravel,- SiReact,+ SiMintlify,+ SiReact,SiNextdotjs,SiGatsby,SiRemix,@@ -78,6 +79,12 @@ And then learn how to add the [Tracking Script](/docs/script) to your website tohref="/docs/guides/astro"className="flex items-center gap-2"/>+ <Card+ icon={<SiMintlify className="w-5 h-5" />}+ title="Mintlify"+ href="/docs/guides/mintlify"+ className="flex items-center gap-2"+ /><Cardtitle="Bubble"href="/docs/guides/bubble"diff --git a/docs/public/platforms/mintlify.svg b/docs/public/platforms/mintlify.svgnew file mode 100644index 000000000..3125157f7--- /dev/null+++ b/docs/public/platforms/mintlify.svg@@ -0,0 +1,6 @@+<svg width="1000" height="1000" viewBox="0 0 1000 1000" fill="none" xmlns="http://www.w3.org/2000/svg">+<rect width="1000" height="1000" rx="64" fill="#041811"/>+<path d="M328.655 428.699C329.076 371.36 351.816 316.439 392.051 275.585H391.977L236.638 430.924H236.712C236.134 431.379 235.589 431.874 235.081 432.407C197.303 470.136 174.398 520.224 170.571 573.478C166.744 626.732 182.251 679.58 214.246 722.324L371.142 565.428L372.773 563.87C343.531 524.929 328.016 477.394 328.655 428.699V428.699Z" fill="#0C8C5E"/>+<path d="M705.844 589.451C676.112 618.588 638.793 638.785 598.139 647.739C557.485 656.693 515.133 654.044 475.912 640.094C455 632.671 435.347 622.094 417.632 608.73L416.001 610.361L259.104 767.183C301.865 799.098 354.685 814.556 407.905 810.73C461.126 806.904 511.191 784.05 548.947 746.347L550.504 744.79L705.844 589.451Z" fill="#0C8C5E"/>+<path d="M772.428 430.924V209H550.505C521.359 208.971 492.494 214.701 465.569 225.86C438.644 237.019 414.189 253.389 393.609 274.028L392.051 275.585C364.925 303.124 345.516 337.312 335.773 374.72C353.41 370.153 371.535 367.738 389.753 367.528C438.45 366.954 485.971 382.491 524.924 411.72C559.933 437.828 586.429 473.715 601.073 514.859C615.998 556.911 617.961 602.475 606.709 645.655C644.123 635.929 678.315 616.518 705.844 589.377L707.401 587.894C728.049 567.305 744.423 542.838 755.583 515.9C766.742 488.961 772.467 460.082 772.428 430.924V430.924Z" fill="#18E299"/>+</svg>diff --git a/docs/src/components/Integration.tsx b/docs/src/components/Integration.tsxindex 6e8328d64..a94ae2e8b 100644--- a/docs/src/components/Integration.tsx+++ b/docs/src/components/Integration.tsx@@ -20,6 +20,7 @@ const platforms = [{ name: "GTM", logo: "/platforms/gtm.svg", path: "/docs/guides/google-tag-manager" },{ name: "Docusaurus", logo: "/platforms/docusaurus.svg", path: "/docs/guides/docusaurus" },{ name: "WooCommerce", logo: "/platforms/woocommerce.svg", path: "/docs/guides/woocommerce" },+ { name: "Mintlify", logo: "/platforms/mintlify.svg", path: "/docs/guides/mintlify" },];// Shuffle function to randomize array order