django-plausible

Django模块，用于提供易于使用的Plausible集成，支持Wagtail。

安装

pip install django-plausible

然后只需将 plausible 添加到 INSTALLED_APPS。

使用

django-plausible 提供了一个 plausible 模板标签，可用于输出Plausible所需的 脚本标签。

{% load plausible %}

{% plausible %}

结果将是

<script defer data-domain="example.com" src="https://#/js/plausible.js"></script>

配置

配置可以在 settings.py 中更改，或在调用 plausible 模板标签时更改

• PLAUSIBLE_DOMAIN：Plausible运行所在的域名（默认为 plausible.io）
• PLAUSIBLE_SCRIPT_NAME：要使用的脚本名称（默认为 plausible.js）。有关可用选项，请参阅 脚本扩展。

这些设置将影响对plausible模板标签的所有调用。为了在调用时覆盖它，您还可以将它们传递给模板标签。

{% plausible plausible_domain="my-plausible.com" script_name="plausible.hash.js" %}

默认情况下，将使用的域（data-domain）将基于请求的主机名（使用request.get_host()）。要覆盖此设置，请将site_domain传递给模板标签。

如果使用了"兼容"脚本，则django-plausible将自动将所需的id添加到script标签中。默认情况下，它被排除，以帮助隐藏Plausible的存在。

与Wagtail的使用

此外，django-plausible提供与Wagtail的（可选）深度集成，允许通过Wagtail管理员进行配置。要启用此功能，请将plausible.contrib.wagtail添加到INSTALLED_APPS。

配置通过“Plausible Analytics”设置完成

• site_domain：用于data-domain的值。如果为空（默认值），将使用请求的主机名（如上所述），而不是站点主机名。
• plausible_domain：Plausible运行所在的域名（如上所述）
• script_name：要使用的脚本名称（如上所述）

要访问模板标签，请加载plausible_wagtail而不是plausible。模板标签本身仍然是plausible。请注意，与Django变体不同，Wagtail模板标签不允许传递选项。

{% load plausible_wagtail %}

{% plausible %}