README

轻松将Marker.io集成到CraftCMS中。

Marker.io是Mostly Serious开发团队的首选QA工具。Mostly Serious插件允许您将他们的报告小部件添加到Craft站点的前后端，使用户能够轻松报告问题。

要求

此插件需要Craft CMS 4.9.0或更高版本，以及PHP 8.0.2或更高版本。

安装

您可以从插件商店或使用Composer安装此插件。

从插件商店

转到项目的控制面板中的插件商店，搜索“Marker.io”，然后点击“安装”。

使用Composer

打开您的终端并运行以下命令

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require mostlyserious/craft-markerio

# tell Craft to install the plugin
./craft plugin/install markerio

用法

在Marker.io上注册账户并复制您的项目ID。
将项目ID添加到插件设置中。

这就完成了！您可以使用提供的设置进一步配置小部件。所有配置设置都可以通过您的config文件夹中的marker.php文件覆盖。

<?php

use craft\helpers\App;

/* Example /config/markerio.php */

return [
    'project' => App::env('YOUR_ENV_VAR_HERE'),
    'enableWidgetFe' => true,
    'enableWidgetCp' => true,
    'requireLogin' => false,
    'silent' => false,
    'renderDelay' => 1200,
    'keyboardShortcuts' => false,
    'useNativeScreenshot' => false,
    'extension' => false,
];

插件会自动将Marker.io小部件添加到<head>中。

变量和高级配置

如果您需要高级功能，如报告者识别或自定义元数据，或者您希望手动将Marker.io小部件添加到模板中，您可以在Twig模板中使用以下变量

{{ craft.markerio.project }}
{# The project id, ex: "369ajJu************" #}

{{ craft.markerio.markerConfig }}
{# The configuration data as an associative array, ex. '{{ craft.markerio.markerConfig.project }}' #}

{{ craft.markerio.markerConfigScript|raw }}
{# The configuration script, ex 'window.markerConfig = { ... }' including your config settings (no script tag). #}

{{ craft.markerio.widgetShim|raw }}
{# The Marker.io width shim, ex '!function(...' with no script tag. #}

在手动渲染小部件时，请确保在您的配置设置中禁用前端的小部件。

return [
    'enableWidgetFe' => false,
    // ...
];

您还需要在手动渲染小部件时管理自己的requireLogin逻辑。

mostlyserious / craft-markerio

维护者

详细信息

README

要求

安装

从插件商店

使用Composer

用法

变量和高级配置