Set Up Vercel Web Analytics Integration

.vitepress/config.mts

@@ -6,6 +6,8 @@ export default defineConfig({
   description:
     "End-to-end testing toolkit for blockchain applications, powered by Playwright",
 
+  ignoreDeadLinks: true,
+
   head: [
     // Vercel Web Analytics will be injected via theme setup
   ],
@@ -16,6 +18,7 @@ export default defineConfig({
       { text: "Home", link: "/" },
       { text: "Guide", link: "/guide" },
       { text: "Examples", link: "/examples" },
+      { text: "Vercel Web Analytics", link: "/vercel-web-analytics" },
     ],
 
     sidebar: [
@@ -24,6 +27,7 @@ export default defineConfig({
         items: [
           { text: "Introduction", link: "/guide" },
           { text: "Installation", link: "/installation" },
+          { text: "Vercel Web Analytics", link: "/vercel-web-analytics" },
         ],
       },
     ],

.vitepress/theme/index.ts

@@ -1,6 +1,6 @@
 import { inject } from "@vercel/analytics"
-import DefaultTheme from "vitepress/theme"
 import type { Theme } from "vitepress"
+import DefaultTheme from "vitepress/theme"
 
 // Inject Vercel Web Analytics
 // Note: inject() runs on the client side and does not include route support

docs/vercel-web-analytics.md

@@ -0,0 +1,342 @@
+# Getting started with Vercel Web Analytics
+
+This guide will help you get started with using Vercel Web Analytics on your project, showing you how to enable it, add the package to your project, deploy your app to Vercel, and view your data in the dashboard.
+
+**Select your framework to view instructions on using the Vercel Web Analytics in your project**.
+
+## Prerequisites
+
+- A Vercel account. If you don't have one, you can sign up for free at vercel.com/signup.
+- A Vercel project. If you don't have one, you can create a new project at vercel.com/new.
+- The Vercel CLI installed. If you don't have it, you can install it using the following command:
+
+```bash
+pnpm i vercel
+```
+
+Or using your preferred package manager:
+
+```bash
+# yarn
+yarn i vercel
+
+# npm
+npm i vercel
+
+# bun
+bun i vercel
+```
+
+## Enable Web Analytics in Vercel
+
+On the Vercel dashboard, select your Project and then click the **Analytics** tab and click **Enable** from the dialog.
+
+> **💡 Note:** Enabling Web Analytics will add new routes (scoped at `/_vercel/insights/*`)
+> after your next deployment.
+
+## Add `@vercel/analytics` to your project
+
+Using the package manager of your choice, add the `@vercel/analytics` package to your project:
+
+```bash
+# pnpm
+pnpm i @vercel/analytics
+
+# yarn
+yarn i @vercel/analytics
+
+# npm
+npm i @vercel/analytics
+
+# bun
+bun i @vercel/analytics
+```
+
+## Add the `Analytics` component to your app
+
+### For VitePress and Vue
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Vue, including route support.
+
+Add the following code to your main component:
+
+```ts
+// src/App.vue
+<script setup lang="ts">
+import { Analytics } from '@vercel/analytics/vue';
+</script>
+
+<template>
+  <Analytics />
+  <!-- your content -->
+</template>
+```
+
+Or in JavaScript:
+
+```js
+// src/App.vue
+<script setup>
+import { Analytics } from '@vercel/analytics/vue';
+</script>
+
+<template>
+  <Analytics />
+  <!-- your content -->
+</template>
+```
+
+### For Next.js (Pages Router)
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Next.js, including route support.
+
+If you are using the `pages` directory, add the following code to your main app file:
+
+```tsx
+// pages/_app.tsx
+import type { AppProps } from "next/app";
+import { Analytics } from "@vercel/analytics/next";
+
+function MyApp({ Component, pageProps }: AppProps) {
+  return (
+    <>
+      <Component {...pageProps} />
+      <Analytics />
+    </>
+  );
+}
+
+export default MyApp;
+```
+
+### For Next.js (App Router)
+
+Add the following code to the root layout:
+
+```tsx
+// app/layout.tsx
+import { Analytics } from "@vercel/analytics/next";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <head>
+        <title>Next.js</title>
+      </head>
+      <body>
+        {children}
+        <Analytics />
+      </body>
+    </html>
+  );
+}
+```
+
+### For Remix
+
+The `Analytics` component is a wrapper around the tracking script, offering a seamless integration with Remix, including route detection.
+
+Add the following code to your root file:
+
+```tsx
+// app/root.tsx
+import {
+  Links,
+  LiveReload,
+  Meta,
+  Outlet,
+  Scripts,
+  ScrollRestoration,
+} from "@remix-run/react";
+import { Analytics } from "@vercel/analytics/remix";
+
+export default function App() {
+  return (
+    <html lang="en">
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Links />
+      </head>
+      <body>
+        <Analytics />
+        <Outlet />
+        <ScrollRestoration />
+        <Scripts />
+        <LiveReload />
+      </body>
+    </html>
+  );
+}
+```
+
+### For Nuxt
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Nuxt, including route support.
+
+Add the following code to your main component:
+
+```ts
+// app.vue
+<script setup lang="ts">
+import { Analytics } from '@vercel/analytics/nuxt';
+</script>
+
+<template>
+  <Analytics />
+  <NuxtPage />
+</template>
+```
+
+### For SvelteKit
+
+The `injectAnalytics` function is a wrapper around the tracking script, offering more seamless integration with SvelteKit, including route support.
+
+Add the following code to the main layout:
+
+```ts
+// src/routes/+layout.ts
+import { dev } from "$app/environment";
+import { injectAnalytics } from "@vercel/analytics/sveltekit";
+
+injectAnalytics({ mode: dev ? "development" : "production" });
+```
+
+### For Astro
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Astro, including route support.
+
+Add the following code to your base layout:
+
+```tsx
+// src/layouts/Base.astro
+---
+import Analytics from '@vercel/analytics/astro';
+{/* ... */}
+---
+
+<html lang="en">
+	<head>
+      <meta charset="utf-8" />
+      <!-- ... -->
+      <Analytics />
+	</head>
+	<body>
+		<slot />
+    </body>
+</html>
+```
+
+> **💡 Note:** The `Analytics` component is available in version `@vercel/[email protected]` and later.
+> If you are using an earlier version, you must configure the `webAnalytics` property of the Vercel adapter in your `astro.config.mjs` file:
+
+```ts
+// astro.config.mjs
+import { defineConfig } from "astro/config";
+import vercel from "@astrojs/vercel/serverless";
+
+export default defineConfig({
+  output: "server",
+  adapter: vercel({
+    webAnalytics: {
+      enabled: true, // set to false when using @vercel/[email protected]
+    },
+  }),
+});
+```
+
+### For plain HTML
+
+For plain HTML sites, you can add the following script to your `.html` files:
+
+```html
+<!-- index.html -->
+<script>
+  window.va = window.va || function () { (window.vaq = window.vaq || []).push(arguments); };
+</script>
+<script defer src="/_vercel/insights/script.js"></script>
+```
+
+> **💡 Note:** When using the HTML implementation, there is no need to install the
+> `@vercel/analytics` package. However, there is no route support.
+
+### For other frameworks
+
+Import the `inject` function from the package, which will add the tracking script to your app. **This should only be called once in your app, and must run in the client**.
+
+> **💡 Note:** There is no route support with the `inject` function.
+
+Add the following code to your main app file:
+
+```ts
+// main.ts
+import { inject } from "@vercel/analytics";
+
+inject();
+```
+
+### For Create React App
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with React.
+
+> **💡 Note:** When using the plain React implementation, there is no route support.
+
+Add the following code to the main app file:
+
+```tsx
+// App.tsx
+import { Analytics } from "@vercel/analytics/react";
+
+export default function App() {
+  return (
+    <div>
+      {/* ... */}
+      <Analytics />
+    </div>
+  );
+}
+```
+
+## Deploy your app to Vercel
+
+Deploy your app using the following command:
+
+```bash
+vercel deploy
+```
+
+If you haven't already, we also recommend connecting your project's Git repository, which will enable Vercel to deploy your latest commits to main without terminal commands.
+
+Once your app is deployed, it will start tracking visitors and page views.
+
+> **💡 Note:** If everything is set up properly, you should be able to see a Fetch/XHR
+> request in your browser's Network tab from `/_vercel/insights/view` when you
+> visit any page.
+
+## View your data in the dashboard
+
+Once your app is deployed, and users have visited your site, you can view your data in the dashboard.
+
+To do so, go to your Vercel dashboard, select your project, and click the **Analytics** tab.
+
+After a few days of visitors, you'll be able to start exploring your data by viewing and filtering the panels.
+
+Users on Pro and Enterprise plans can also add custom events to their data to track user interactions such as button clicks, form submissions, or purchases.
+
+Learn more about how Vercel supports privacy and data compliance standards with Vercel Web Analytics.
+
+## Next steps
+
+Now that you have Vercel Web Analytics set up, you can explore the following topics to learn more:
+
+- Learn how to use the `@vercel/analytics` package
+- Learn how to set update custom events
+- Learn about filtering data
+- Read about privacy and compliance
+- Explore pricing
+- Troubleshooting