PaulMorel/fathom-analytics

Fathom Analytics 服务集成到您站点的 Kirby 3 插件。

维护者

详细信息

github.com/PaulMorel/kirby3-fathom-analytics

源代码

问题

安装次数: 2,362

依赖: 0

建议者: 0

安全性: 0

星标: 10

关注者: 3

分支: 1

公开问题: 1

类型:kirby-plugin

1.0.0 2021-10-22 02:44 UTC

Requires

MIT 91bb02aecfb936cd326d325fe4bdf4deac5b47d6

  • Paul Morel <paul.woop@paulmorel.com>

This package is auto-updated.

Last update: 2024-09-22 08:58:41 UTC

README

GitHub release (latest by date) Kirby CMS Version License

这是一个用于将关注隐私的 Fathom Analytics 服务集成到您站点的 Kirby 3 插件。

主要功能

此插件执行两项操作

  • 它提供了一个面板视图，可以直接在面板中显示 Fathom Analytics 控制台
  • 它提供了一个片段来嵌入 Fathom Analytics 跟踪代码

要求

  • Kirby CMS v3.4.0+

安装

下载

下载并将此存储库复制到您的 Kirby 3 安装程序的插件文件夹中。您应该得到以下文件夹结构

/site/plugins/fathom-analytics

Git 子模块

如果您更喜欢使用 Git 子模块，可以按以下方式安装插件

git submodule add https://github.com/PaulMorel/kirby3-fathom-analytics.git site/plugins/fathom-analytics

Composer

如果您正在使用 Composer，可以按以下方式安装插件

composer require paulmorel/fathom-analytics

用法

设置

安装插件后，在您的 Fathom Analytics 设置中需要进行几个重要步骤。

  1. 如果尚未完成，请将您的站点添加到 Fathom Analytics
  2. 转到您的站点设置并获取 SiteID。
  3. 仍然在站点设置中，设置站点共享，可以是公开或私人。

之后，在您的站点配置中添加您的 SiteID 和共享密码（如果需要）。

示例

return [
    /* ... */
    'paulmorel.fathom-analytics' => [
        'siteId' => 'ABCDEFGH',
        'sharePassword' => 'hunter2'
    ]
    /* ... */
];

嵌入跟踪代码

跟踪代码以片段的形式提供，因此可以使用 snippet() 辅助函数简单地嵌入到 <head> 标签中。

如果没有提供 siteId，则片段不执行任何操作。

<head>
    <!-- ... -->
    <php snippet('fathom-analytics-embed'); ?>
    <!-- ... -->
</head>

查看您的统计数据

此插件提供了一个面板视图，通过 iframe 加载您的站点分析控制台。只需在面板的顶部菜单中打开菜单并单击分析即可。

选项

siteId (必需)

这是 Fathom Analytics 在您的站点设置页面顶部提供的 SiteID。

sharePassword

这是您的站点控制台的共享密码。仅当您将站点共享设置为私人时才需要。

customDomain

如果您使用 Fathom Analytics 的自定义域名功能，可以使用此选项设置。

示例

'customDomain' => 'https://armadillo.example.com'

disableForRole

允许您为具有指定角色的登录用户禁用跟踪代码。期望为 Array。默认为 ['admin']。

示例

'disableForRole' => [
    'admin'
],
'disableForRole' => [
    'admin',
    'editor',
    'translator'
],

免责声明

此插件“原样”提供，无任何保证。自行承担风险，并在生产环境中使用之前始终进行测试。如果您发现任何问题，请创建一个新的问题。

许可证

MIT

支持

此插件完全免费使用，但如果您想支持我或此项目，请考虑使用我的联盟链接注册 Fathom Analytics。