Plausible Analytics 集成
将 Plausible Analytics 添加到文档站点,这是一种轻量、无 Cookie 的 Google Analytics 替代方案。
将 Plausible Analytics 添加到文档站点,无需 Cookie 或跨站跟踪即可获取流量数据。
Plausible 是开源的,体积不到 1 KB。大多数司法管辖区不要求为其显示 Cookie 同意横幅。
如果你确实需要同意管理(或同时使用 GA、GTM 或 Crisp),请参阅 Cookie 同意。
请选择以下两种设置之一:
| 设置 | 适用场景 | 字段 |
|---|---|---|
| 标准 | 你使用 Plausible 免费套餐,或付费套餐但不需要代理 | domain |
| 代理脚本 | 你使用付费套餐,并希望绕过广告拦截器 | scriptUrl |
标准设置 (domain)
大多数站点使用此设置。在 Plausible 中注册你的站点并传入域名。
注册 Plausible
在 Plausible Analytics 创建账户,并添加你的文档站点域名(例如 docs.example.com)。
将域名添加到 docs.json
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com"
}
}
}请使用你注册时的完整域名:docs.example.com,而不是 www.docs.example.com。
自托管服务器
如果你运行 Community Edition,请添加 server 字段。它会将脚本和事件 API 指向你的实例:
{
"name": "My Docs",
"integrations": {
"plausible": {
"domain": "docs.example.com",
"server": "https://analytics.example.com"
}
}
}server 仅可与 domain 搭配使用。代理脚本自行处理路由。
代理脚本设置 (scriptUrl)
Plausible 的付费套餐提供带有唯一文件名(如 pa-XXXXX.js)的代理脚本。它们可以绕过大多数广告拦截器,因为脚本 URL 不会匹配常见的过滤列表。
获取代理脚本 URL
在 Plausible 的站点设置中,找到代理脚本部分并复制完整 URL。其格式类似 https://plausible.io/js/pa-XXXXX.js。
将脚本 URL 添加到 docs.json
{
"name": "My Docs",
"integrations": {
"plausible": {
"scriptUrl": "https://plausible.io/js/pa-XXXXX.js"
}
}
}省略 domain 和 server。脚本 ID 已包含你的站点标识,Plausible 的 CDN 会在内部完成路由。
验证安装
检查数据是否正常传入:
- 触发文档的重新构建
- 访问你的线上文档站点
- 查看 Plausible 仪表板。你的访问记录应在几秒钟内出现。
- 或者打开 DevTools,进入 Network 标签页,查找对
plausible.io/js/script.js(标准)或你的pa-XXXXX.js脚本(代理)的请求
Plausible 实时显示数据,无需像 Google Analytics 那样等待。
配置参考
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
domain | string | domain 或 scriptUrl 二选一 | 你在 Plausible 中注册的站点域名。用作脚本标签上的 data-domain 属性。 |
scriptUrl | string | domain 或 scriptUrl 二选一 | Plausible 付费代理脚本(pa-XXXXX.js)的完整 URL。站点标识已内置于脚本中,无需 domain 字段。 |
server | string | 否 | 自托管 Plausible 服务器的 URL。仅与 domain 搭配使用,不与 scriptUrl 搭配。 |
故障排除
通常原因是域名。它必须与你在 Plausible 中注册的域名完全一致(docs.example.com,而不是 www.docs.example.com)。
如果域名看起来正确:
- 重新构建文档。配置更改只有在新构建后才会生效。
- 检查广告拦截器。一些浏览器扩展会屏蔽包括 Plausible 在内的分析脚本。如果是这个原因,请切换到代理脚本设置。
- 检查页面源代码,查找带有
data-domain(标准)或你的pa-XXXXX.js文件名(代理)的<script>标签。如果没有,说明配置未生效。
注册读者访问的域名。如果你的文档位于 docs.example.com,请将其用作 domain,而不是你的根域名。
切换到代理脚本设置。唯一的文件名可以绕过大多数广告拦截器的过滤列表。自托管也能绕过广告拦截器,因为脚本从你自己的域名加载。
如果你使用免费套餐或不介意广告拦截器,请使用 domain。如果你使用付费套餐并希望获得最全面的跟踪覆盖,请使用 scriptUrl。不要同时设置两者。
