Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions fern/assets/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -1195,3 +1195,102 @@ h1, h2, h3 {
margin-top: 1.5rem;
}
/*** END -- PROMPT STYLING ***/

/* Cookie consent banner (cookie-consent.js) */
#fern-cookie-banner {
position: fixed;
bottom: 1rem;
left: 1rem;
z-index: 1000;
display: flex;
flex-direction: column;
gap: 0.75rem;
max-width: 24rem;
padding: 1rem;
border: 1px solid var(--grayscale-a5);
border-radius: 0.5rem;
background-color: var(--grayscale-1);
box-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);
color: var(--grayscale-11);
font-size: 0.875rem;
line-height: 1.4;
}

@media (max-width: 640px) {
#fern-cookie-banner {
right: 1rem;
max-width: none;
}
}

#fern-cookie-banner .fern-cookie-banner-text {
margin: 0;
}

#fern-cookie-banner .fern-cookie-banner-text a {
color: var(--grayscale-12);
text-decoration: underline;
text-underline-offset: 4px;
}

#fern-cookie-banner .fern-cookie-banner-actions {
display: flex;
gap: 0.5rem;
}

#fern-cookie-banner button {
height: 2rem;
padding: 0 0.75rem;
border: 1px solid var(--grayscale-a6);
border-radius: 0.375rem;
background-color: transparent;
color: var(--grayscale-12);
font-size: 0.875rem;
font-weight: 500;
cursor: pointer;
}

#fern-cookie-banner .fern-cookie-banner-actions {
flex-wrap: wrap;
}

#fern-cookie-banner button.fern-cookie-banner-primary {
border-color: var(--grayscale-12);
background-color: var(--grayscale-12);
color: var(--grayscale-1);
}

#fern-cookie-banner button.fern-cookie-banner-ghost {
border-color: transparent;
}

#fern-cookie-banner .fern-cookie-banner-settings {
display: flex;
flex-direction: column;
gap: 0.75rem;
}

#fern-cookie-banner .fern-cookie-banner-option {
display: flex;
align-items: flex-start;
gap: 0.5rem;
cursor: pointer;
}

#fern-cookie-banner .fern-cookie-banner-option input {
margin-top: 0.2rem;
appearance: auto;
-webkit-appearance: auto;
accent-color: var(--grayscale-12);
}

#fern-cookie-banner .fern-cookie-banner-option > span {
display: flex;
flex-direction: column;
gap: 0.125rem;
}

#fern-cookie-banner .fern-cookie-banner-option strong {
color: var(--grayscale-12);
font-weight: 500;
}
1 change: 1 addition & 0 deletions fern/components/FernFooter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,7 @@ export default function FernFooter() {
<a href="https://brandfetch.com/buildwithfern.com" className="fern-cf-link">Brand Kit</a>
<a href="https://buildwithfern.com/privacy-policy" className="fern-cf-link">Privacy Policy</a>
<a href="https://buildwithfern.com/terms-of-service" className="fern-cf-link">Terms of Service</a>
<a href="#cookie-settings" data-fern-cookie-settings="" className="fern-cf-link">Cookie Settings</a>
</div>
</div>

Expand Down
247 changes: 247 additions & 0 deletions fern/cookie-consent.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,247 @@
// Cookie consent banner for buildwithfern.com/learn.
//
// Shares the `fern_cookie_consent` cookie (`analytics:0|marketing:0`) with the
// marketing site (fern-api/marketing-site `src/lib/cookie-consent.ts`), so a
// visitor chooses once for both.
// - Analytics gates Fern's PostHog (`settings.require-analytics-consent`).
// - Marketing gates Google Tag Manager, which loads from here instead of
// `analytics.gtm` because Fern doesn't gate that on consent.
(function () {
if (window.__fernCookieConsent) return;
window.__fernCookieConsent = true;

var COOKIE = "fern_cookie_consent";
var COOKIE_VALUE_PATTERN = /^analytics:([01])\|marketing:([01])$/;
var GTM_ID = "GTM-55W3VNDW";
var TRACK_EVENT = "fern-docs-track-analytics";
var BANNER_ID = "fern-cookie-banner";
var CATEGORY_COOKIE_PREFIXES = {
analytics: ["_ga", "_gid", "_gat", "ph_", "__ph_", "_hj"],
marketing: ["_gcl", "_rm", "li_", "__q", "_uet", "_fbp"],
};
var CATEGORIES = [
{
key: "analytics",
label: "Analytics",
description: "Helps us understand how visitors use the docs (PostHog).",
},
{
key: "marketing",
label: "Marketing",
description: "Measures our ads and campaigns (Google Tag Manager).",
},
];
var ALL_GRANTED = { analytics: true, marketing: true };
var ALL_DENIED = { analytics: false, marketing: false };

// What this page has already turned on. Scripts can't be unloaded, so
// revoking one of these reloads the page.
var active = { analytics: false, marketing: false };

function readConsent() {
var parts = document.cookie.split(";");
for (var i = 0; i < parts.length; i++) {
var pair = parts[i].trim().split("=");
var match = pair[0] === COOKIE && COOKIE_VALUE_PATTERN.exec(pair[1] || "");
if (match) return { analytics: match[1] === "1", marketing: match[2] === "1" };
}
return null;
}

function writeConsent(consent) {
var host = window.location.hostname;
var domain = host === "buildwithfern.com" || /\.buildwithfern\.com$/.test(host) ? "; domain=.buildwithfern.com" : "";
var value = "analytics:" + (consent.analytics ? 1 : 0) + "|marketing:" + (consent.marketing ? 1 : 0);
document.cookie = COOKIE + "=" + value + "; path=/; max-age=31536000; samesite=lax" + domain;
}

function clearCookies(consent) {
var prefixes = [];
CATEGORIES.forEach(function (category) {
if (!consent[category.key]) prefixes = prefixes.concat(CATEGORY_COOKIE_PREFIXES[category.key]);
});
if (prefixes.length === 0) return;
var labels = window.location.hostname.split(".");
var domains = [""];
for (var i = 0; i < labels.length; i++) domains.push("; domain=." + labels.slice(i).join("."));
document.cookie.split(";").forEach(function (part) {
var name = part.split("=")[0].trim();
var matches = prefixes.some(function (prefix) {
return name.indexOf(prefix) === 0;
});
if (!matches) return;
domains.forEach(function (domain) {
document.cookie = name + "=; path=/; max-age=0" + domain;
});
});
}

function loadGtm(analyticsGranted) {
window.dataLayer = window.dataLayer || [];
function gtag() {
window.dataLayer.push(arguments);
}
var analytics = analyticsGranted ? "granted" : "denied";
gtag("consent", "default", {
analytics_storage: analytics,
ad_storage: "granted",
ad_user_data: "granted",
ad_personalization: "granted",
});
window.dataLayer.push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
var script = document.createElement("script");
script.async = true;
script.src = "https://www.googletagmanager.com/gtm.js?id=" + GTM_ID;
document.head.appendChild(script);
// Forward Fern's docs events to the dataLayer, as `analytics.gtm` does,
// without the feedback email.
window.addEventListener(TRACK_EVENT, function (event) {
var detail = event.detail;
if (!detail || typeof detail.event !== "string" || detail.internal) return;
var properties = Object.assign({}, detail.properties);
delete properties.email;
delete properties.allowFollowUpViaEmail;
window.dataLayer.push({ event: detail.event, properties: properties });
});
}

// Turns on what `consent` allows, or reloads if it revokes something this
// page already turned on (including a change made in another tab or on the
// marketing site).
function apply(consent) {
if ((active.analytics && !consent.analytics) || (active.marketing && !consent.marketing)) {
window.fernAnalyticsConsent = false;
window.dispatchEvent(new Event("fern-analytics-consent"));
clearCookies(consent);
window.location.reload();
return;
}
clearCookies(consent);
if (active.marketing && consent.analytics && !active.analytics) {
// GTM is already running with `analytics_storage` denied.
window.dataLayer.push(
(function () {
return arguments;
})("consent", "update", { analytics_storage: "granted" })
);
}
if (consent.analytics && !active.analytics) {
active.analytics = true;
window.fernAnalyticsConsent = true;
window.dispatchEvent(new Event("fern-analytics-consent"));
}
if (consent.marketing && !active.marketing) {
active.marketing = true;
loadGtm(consent.analytics);
}
}

function choose(consent) {
writeConsent(consent);
removeBanner();
apply(consent);
}

function removeBanner() {
var banner = document.getElementById(BANNER_ID);
if (banner) banner.remove();
}

function escapeHtml(text) {
return text.replace(/[&<>"]/g, function (c) {
return { "&": "&amp;", "<": "&lt;", ">": "&gt;", '"': "&quot;" }[c];
});
}

function showBanner(withSettings) {
if (!document.body) return;
removeBanner();
var current = readConsent() || ALL_DENIED;
var banner = document.createElement("div");
banner.id = BANNER_ID;
banner.setAttribute("role", "region");
banner.setAttribute("aria-label", "Cookie consent");
var settings = "";
if (withSettings) {
settings =
'<div class="fern-cookie-banner-settings">' +
'<label class="fern-cookie-banner-option"><input type="checkbox" checked disabled />' +
"<span><strong>Strictly necessary</strong><span>Required for the site to work, including remembering this choice.</span></span></label>" +
CATEGORIES.map(function (category) {
return (
'<label class="fern-cookie-banner-option"><input type="checkbox" data-category="' +
category.key +
'"' +
(current[category.key] ? " checked" : "") +
" /><span><strong>" +
escapeHtml(category.label) +
"</strong><span>" +
escapeHtml(category.description) +
"</span></span></label>"
);
}).join("") +
"</div>";
}
banner.innerHTML =
'<p class="fern-cookie-banner-text">We use cookies for analytics and marketing. Read our ' +
'<a href="https://buildwithfern.com/privacy-policy">privacy policy</a>.</p>' +
settings +
'<div class="fern-cookie-banner-actions">' +
'<button type="button" class="fern-cookie-banner-primary" data-action="accept">Accept all</button>' +
'<button type="button" data-action="reject">Reject all</button>' +
(withSettings
? '<button type="button" data-action="save">Save choices</button>'
: '<button type="button" class="fern-cookie-banner-ghost" data-action="manage">Manage</button>') +
"</div>";
banner.addEventListener("click", function (event) {
var button = event.target instanceof Element ? event.target.closest("button[data-action]") : null;
if (!button) return;
var action = button.getAttribute("data-action");
if (action === "accept") choose(ALL_GRANTED);
else if (action === "reject") choose(ALL_DENIED);
else if (action === "manage") showBanner(true);
else if (action === "save") {
var consent = { analytics: false, marketing: false };
banner.querySelectorAll("input[data-category]").forEach(function (input) {
consent[input.getAttribute("data-category")] = input.checked;
});
choose(consent);
}
});
document.body.appendChild(banner);
}

var initial = readConsent();
window.fernAnalyticsConsent = false;
if (initial) apply(initial);

function onPageReady() {
if (readConsent() === null && !document.getElementById(BANNER_ID)) showBanner(false);
}
if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", onPageReady);
} else {
onPageReady();
}
// Client-side navigation can replace <body>, which drops the banner.
document.addEventListener("astro:page-load", onPageReady);
document.addEventListener("astro:after-swap", onPageReady);

// Pick up a choice made in another tab or on the marketing site.
function syncFromCookie() {
var consent = readConsent();
if (consent) apply(consent);
}
window.addEventListener("focus", syncFromCookie);
document.addEventListener("visibilitychange", function () {
if (document.visibilityState === "visible") syncFromCookie();
});

// The footer's "Cookie Settings" link reopens the banner with the toggles.
document.addEventListener("click", function (event) {
var target = event.target instanceof Element ? event.target.closest("[data-fern-cookie-settings]") : null;
if (!target) return;
event.preventDefault();
showBanner(true);
});
})();
13 changes: 8 additions & 5 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ page-actions:
url: https://github.com/fern-api/skills/tree/main/skills/fern-workflows

settings:
require-analytics-consent: true
http-snippets:
- curl
search:
Expand All @@ -229,15 +230,17 @@ settings:
js:
- path: ./rive-animation.js
strategy: afterInteractive
- path: ./cookie-consent.js
strategy: beforeInteractive

agents:
page-directive: "For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt. For task-scoped instructions for coding agents working in a Fern project, run `fern instructions` (or `npx fern-api@latest instructions` if the Fern CLI isn't installed or doesn't recognize `instructions`), or see https://buildwithfern.com/learn/home/fern-instructions.md."

analytics:
# posthog:
# api-key: ${POSTHOG_API_KEY}
gtm:
container-id: GTM-55W3VNDW
# Google Tag Manager (GTM-55W3VNDW) loads from cookie-consent.js after the
# visitor accepts cookies, so it isn't configured under `analytics`.
# analytics:
# posthog:
# api-key: ${POSTHOG_API_KEY}

experimental:
mdx-components:
Expand Down
Loading