这个项目能做什么
Nuxt Plausible 是一个轻量级模块,用于将 Plausible 分析服务集成到 Nuxt 应用中。安装只需一条命令(`npx nuxt module add plausible`),并在 `nuxt.config.ts` 中的 `modules` 数组添加 `@nuxtjs/plausible` 即可启用跟踪,无需进一步配置。默认情况下,该模块使用当前主机名作为 Plausible 域名,但可以通过 `domain` 选项覆盖此设置。
主要功能包括:
- 自动页面浏览跟踪,支持可选的哈希模式。
- 内置跟踪外部链接点击、文件下载和表单提交,可通过 `autoOutboundTracking`、`fileDownloads` 和 `formSubmissions` 选项进行配置。
- 通过自动导入的组合式函数 `useTrackEvent` 和 `useTrackPageview` 进行手动跟踪,以实现自定义目标和虚拟页面视图。
- 可选代理(`proxy: true`)将事件路由通过 Nuxt 服务器(`/_plausible/api/event`),帮助绕过广告拦截器同时保持 Cookie 在您自己的域名上。
- 通过公共环境变量(例如 `NUXT_PUBLIC_PLAUSIBLE_DOMAIN`)进行运行时配置,便于在不同环境中部署。
- 支持 SSR 的实现,确保不会将仅客户端代码泄露到服务器包中。
配置可在 `nuxt.config.ts` 的 `plausible` 键下或通过 `.env` 变量完成。常见选项包括 `enabled`、`ignoredHostnames`、`ignoreSubDomains`、`apiHost`、`autoPageviews`、`logIgnoredEvents` 以及代理设置如 `proxyBaseEndpoint`。
该模块尊重隐私,仅向 Plausible 发送最少的请求头(用户代理、内容类型、x-forwarded-for),并通过 `enabled: false` 完全禁用跟踪。所有功能都在 README 中有文档说明并附有使用示例。
开发遵循标准的 Nuxt 模块约定:克隆仓库,启用 Corepack,使用 pnpm 安装依赖,运行 `pnpm run dev:prepare`,然后使用 `pnpm run dev` 启动开发服务器。该项目采用 MIT 许可证。
评论
0 评分人数达到10人后显示
登录后参与讨论。