搜索adrienpayet / front-comments
Kirby 插件，用于在前端页面任何位置添加评论。
Requires
- dev-main
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.35
- 0.10.34
- 0.10.33
- 0.10.32
- 0.10.31
- 0.10.30
- 0.10.29
- 0.10.28
- 0.10.27
- 0.10.26
- 0.10.25
- 0.10.24
- 0.10.23
- 0.10.22
- 0.10.21
- 0.10.20
- 0.10.19
- 0.10.18
- 0.10.17
- 0.10.16
- 0.10.15
- 0.10.14
- 0.10.13
- 0.10.12
- 0.10.11
- 0.10.10
- 0.10.9
- 0.10.8
- 0.10.7
- 0.10.6
- 0.10.5
- 0.10.4
- 0.10.3
- 0.10.1
- 0.10.0
- 0.9.3
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.19
- 0.8.18
- 0.8.17
- 0.8.16
- 0.8.15
- 0.8.14
- 0.8.13
- 0.8.12
- 0.8.11
- 0.8.10
- 0.8.9
- 0.8.8
- 0.8.7
- 0.8.6
- 0.8.5
- 0.8.3
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.1
- 0.7.0
- 0.6.3
- 0.6.2
- 0.6.1
- 0.6.0
- 0.5.1
- 0.5.0
- 0.4.0
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.0
- 0.1.11
- 0.1.10
- 0.1.9
- 0.1.8
- 0.1.7
- 0.1.6
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
This package is auto-updated.
Last update: 2024-09-14 14:24:32 UTC
README
Kirby 前端评论插件
“Kirby 前端评论插件” 允许您在 Kirby 网站的任何前端页面添加评论，使得管理员、开发者、设计师和其他合作者能够直接在网站上沟通和协作。它自动将上下文信息整合到每个评论中，例如用户代理、窗口宽度、日期和时间，这使得它成为调试和故障排除的有价值工具。
此外，该插件可以连接到您的 GitHub、GitLab（包括 Framagit）账户，允许您直接从网站创建和关闭问题。这使得跟踪和管理问题变得容易，并将所有协作集中在一个地方。
设置
安装
Composer 是推荐安装插件的方式。 在您的终端中运行以下命令
composer require adrienpayet/front-comments
或者，您也可以下载此存储库并将其添加到项目的 /site/plugins 目录。
包含片段
将片段添加到您的页眉的 <head> 中任何位置： <?php snippet('front-comments') ?>。
与 GitHub 或 GitLab 仓库连接（可选）
要直接从网站上的评论创建问题，请将仓库信息添加到插件的 repo 选项
/site/config/config.php:
return [
'adrienpayet.front-comments.repo.service' => 'github', // REQUIRED - 'github' | 'gitlab' | 'framagit' (case insensive)
'adrienpayet.front-comments.repo.token' => 'glpat-xxxxxxxxxxxxxxxxxxxx', // REQUIRED - access token (see below)
'adrienpayet.front-comments.repo.owner' => 'username', // REQUIRED
'adrienpayet.front-comments.repo.name' => 'repository name', // REQUIRED - 'Your Plugin Name' | 'your-plugin-name'
'adrienpayet.front-comments.repo.labels' => ['bug', 'front-end'], // OPTIONAL - ['label 1', 'label 2'] (Default value is set to ['front-comments']).
]
使用字符串表示法单独设置每个选项。将插件选项作为数组设置将覆盖一些必要的默认选项。
在 GitHub 和 GitLab 上了解如何创建和管理个人访问令牌。
使用
添加新评论
登录用户可以通过点击屏幕右下角的按钮直接在前端添加评论。以下是如何 更改其位置。
通过面板管理评论
要查看和管理所有评论，请访问 your-website.com/panel/comments，也可以从默认面板菜单访问。要将评论全局视图添加到自定义面板菜单，请在您的 /site/config/config.php 中调用 'comments'。
'panel' => [
'menu' => [
'custom-menu-item' => [...],
'-',
'comments'
'users',
]
]
在此部分中，您可以创建和删除评论，以及创建或访问链接问题。
请注意，问题只能通过此部分创建。但是，删除评论（无论是在前端还是面板中）将自动关闭任何链接问题。这确保了您的评论和问题始终同步并保持最新。
自定义
更改添加按钮位置
添加按钮的默认位置设置为右下角。您可以通过将 position 属性传递给片段来更改它
<?php snippet('front-comments', [
'position' => 'bottom-right' // default position
// alternatives :
'position' => 'bottom-left'
'position' => 'top-left'
'position' => 'top-right'
]) ?>
故障排除
修复 403 错误（很少发生）
在极少数情况下，插件文件可能由于 403 错误而无法加载（检查 JavaScript 控制台）。通过将 'location' => 'assets' 属性传递给片段来修复它
<?php snippet('front-comments', ['location' => 'assets']) ?>
这会将文件复制到 /assets/front-comments，这应该可以解决问题。