Skip to content

Commit c4dd69f

Browse files
committed
fix: framer docs
1 parent 5474d20 commit c4dd69f

File tree

1 file changed

+73
-20
lines changed

1 file changed

+73
-20
lines changed

apps/docs/content/docs/Integrations/framer.mdx

Lines changed: 73 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,76 @@ title: Framer
33
description: Add privacy-first analytics to your Framer site
44
---
55

6+
import { Step, Steps } from "@/components/docs";
7+
import { Callout } from "@/components/docs";
8+
import { CodeBlock } from "@/components/docs";
9+
610
Databuddy enables you to gather privacy-first analytics on user behavior, capture custom events, track performance metrics, and more within your Framer site - all while maintaining GDPR compliance without cookies.
711

8-
> **Easy Setup**: Install our [official Framer plugin](https://www.framer.com/marketplace/plugins/databuddy-analytics/) from the Framer Marketplace for the fastest setup, or manually add the script using the instructions below.
12+
<Callout type="info">
13+
**Easy Setup**: Install our [official Framer plugin](https://www.framer.com/marketplace/plugins/databuddy-analytics/) from the Framer Marketplace for the fastest setup, or manually add the script using the instructions below.
14+
</Callout>
915

1016
## Installation Methods
1117

1218
### Option 1: Framer Plugin (Recommended)
1319

1420
The easiest way to add Databuddy to your Framer site is through our official plugin:
1521

22+
<Steps>
23+
<Step>
24+
25+
## Install the Plugin
26+
1627
1. Open your Framer project
1728
2. Go to **Plugins** in the left sidebar
1829
3. Search for "Databuddy Analytics"
1930
4. Click **Install** on the [Databuddy Analytics plugin](https://www.framer.com/marketplace/plugins/databuddy-analytics/)
20-
5. Enter your Client ID from your [Databuddy dashboard](https://app.databuddy.cc)
21-
6. Configure optional settings:
31+
32+
</Step>
33+
<Step>
34+
35+
## Configure Settings
36+
37+
1. Enter your Client ID from your [Databuddy dashboard](https://app.databuddy.cc)
38+
2. Configure optional settings:
2239
- Custom CDN URL (for self-hosted setups)
2340
- Custom Dashboard URL (for self-hosted setups)
24-
7. Publish your site
41+
42+
</Step>
43+
<Step>
44+
45+
## Publish Your Site
46+
47+
Click **Publish** to make your changes live.
2548

2649
**Plugin Benefits**:
2750
- Zero configuration needed
2851
- Automatic updates
2952
- Self-hosted option available
3053
- No manual code editing required
3154

32-
> Plugin created by [@dominikkoch](https://x.com/dominikkoch)
55+
<Callout type="success">
56+
Plugin created by [Dominik Koch](https://dominikkoch.dev/)
57+
</Callout>
58+
59+
</Step>
60+
</Steps>
3361

3462
### Option 2: Manual Installation
3563

3664
If you prefer manual control or need custom configuration:
3765

38-
#### 1. Get Your Tracking Script
66+
<Steps>
67+
<Step>
68+
69+
## Get Your Tracking Script
3970

4071
Navigate to your [Databuddy dashboard](https://app.databuddy.cc) and copy your tracking code snippet:
4172

42-
```html
43-
<script>
73+
<CodeBlock
74+
language="html"
75+
code={`<script>
4476
(function () {
4577
var script = document.createElement("script");
4678
script.async = true;
@@ -51,18 +83,24 @@ Navigate to your [Databuddy dashboard](https://app.databuddy.cc) and copy your t
5183
script.setAttribute("data-track-errors", "true");
5284
document.head.appendChild(script);
5385
})();
54-
</script>
55-
```
86+
</script>`}
87+
/>
88+
89+
</Step>
90+
<Step>
5691

57-
#### 2. Add the Script to Your Framer Project
92+
## Add the Script to Your Framer Project
5893

5994
1. Open your Framer project
6095
2. Go to **Site Settings** > **General**
6196
3. Scroll down to **Custom Code**
6297
4. Paste your Databuddy snippet into the **Start of &lt;head&gt; tag** section
6398
5. Click **Save** and publish your changes
6499

65-
#### 3. Verify Installation
100+
</Step>
101+
<Step>
102+
103+
## Verify Installation
66104

67105
Once published, you can verify that Databuddy is working by:
68106

@@ -71,28 +109,37 @@ Once published, you can verify that Databuddy is working by:
71109
3. Checking the Console tab for a "Databuddy initialized" message
72110
4. Visiting your Databuddy dashboard to see real-time analytics
73111

112+
<Callout type="success">
113+
If you see real-time data in your dashboard, congratulations! Databuddy is now tracking your Framer site analytics.
114+
</Callout>
115+
116+
</Step>
117+
</Steps>
118+
74119
## Advanced Features
75120

76121
### Custom Event Tracking
77122

78123
Track custom interactions in your Framer components using data attributes:
79124

80-
```html
81-
<!-- Track button clicks -->
125+
<CodeBlock
126+
language="html"
127+
code={`<!-- Track button clicks -->
82128
<button data-track="cta_clicked" data-button-type="primary">Get Started</button>
83129
84130
<!-- Track form submissions -->
85131
<form data-track="newsletter_signup" data-form-location="header">
86132
<!-- form content -->
87-
</form>
88-
```
133+
</form>`}
134+
/>
89135

90136
### Performance Monitoring
91137

92138
Enable performance tracking by updating your script configuration:
93139

94-
```html
95-
<script>
140+
<CodeBlock
141+
language="html"
142+
code={`<script>
96143
(function () {
97144
var script = document.createElement("script");
98145
script.async = true;
@@ -104,8 +151,8 @@ Enable performance tracking by updating your script configuration:
104151
script.setAttribute("data-track-errors", "true");
105152
document.head.appendChild(script);
106153
})();
107-
</script>
108-
```
154+
</script>`}
155+
/>
109156

110157
## Benefits for Framer Sites
111158

@@ -123,29 +170,35 @@ Enable performance tracking by updating your script configuration:
123170

124171
### Plugin Issues
125172

173+
<Callout type="warning">
126174
If the plugin isn't working:
127175

128176
1. Ensure you've entered the correct Client ID
129177
2. Verify your site is published (not just preview mode)
130178
3. Check that the plugin is enabled in your Framer project settings
131179
4. For self-hosted setups, verify your CDN and Dashboard URLs are correct
180+
</Callout>
132181

133182
### Script Not Loading
134183

184+
<Callout type="warning">
135185
If Databuddy isn't working:
136186

137187
1. Ensure the script is in the **Start of &lt;head&gt; tag** section
138188
2. Check that your Client ID is correct
139189
3. Verify your site is published (not just preview mode)
140190
4. Check browser console for any error messages
191+
</Callout>
141192

142193
### Data Not Appearing
143194

195+
<Callout type="info">
144196
If analytics data isn't showing:
145197

146198
1. Wait 2-3 minutes for data processing
147199
2. Check that your domain is verified in Databuddy dashboard
148200
3. Ensure you're viewing the correct date range
149201
4. Try visiting your site in an incognito window
202+
</Callout>
150203

151204
Need help? Contact our support team at [[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)