README

Statamic 无头刷新插件通过无缝集成无头 CMS 功能，增强了您的 Statamic 体验。它提供了一个便捷的仪表盘小部件，让您可以直接从 Statamic 后端触发对解耦网站的更新。该插件还支持与特定事件（如条目保存）相关联的自动 URL 触发，确保您的无头网站始终保持最新状态。事件也是可定制的。

主要功能

仪表盘小部件：可选地添加小部件到您的 Statamic 仪表盘，以便进行方便的手动刷新。
事件驱动触发：通过将 URL 触发与条目保存等事件相关联来自动化刷新过程。

轻松管理和同步您的无头 CMS 更新与 Statamic 无头刷新。

安装

要安装 Headless Refresh 插件，请按照以下步骤操作

通过 Composer 安装插件

composer require isaadsalman/headless-refresh

发布插件资源和配置

php artisan vendor:publish --tag=headless-refresh-config

根据需要更新配置文件 config/statamic/headless-refresh.php（请参阅下面的配置部分）。

配置

Headless Refresh 插件的配置在 config/statamic/headless-refresh.php 中。根据需要修改以下选项

return [
    'event_trigger' => env('HEADLESS_REFRESH_EVENT_TRIGGER', false),
    'trigger_link' => env('HEADLESS_REFRESH_TRIGGER_LINK', null),
    'deployment_message' => env('HEADLESS_REFRESH_DEPLOYMENT_MESSAGE', "Deployed"),
    'events' => [
        Statamic\Events\EntrySaved::class,
        Statamic\Events\EntryDeleted::class,
        Statamic\Events\NavSaved::class,
        Statamic\Events\NavDeleted::class,
        Statamic\Events\NavTreeSaved::class,
        Statamic\Events\NavTreeDeleted::class,
        Statamic\Events\TaxonomySaved::class,
        Statamic\Events\TaxonomyDeleted::class,
    ],
    'live_updates_notice_title' => 'Live Updates Notice',
    'live_updates_notice_text' => 'Please note that your updates will be visible online within 5 minutes from when you save an entry. If you require immediate visibility, simply click the button below.',
    'live_updates_notice_button' => 'Refresh Now'
];

配置选项

event_trigger：设置为 true 以启用基于事件的触发。
trigger_link：定义触发无头刷新的 URL 或链接。
deployment_message：自定义成功部署后显示的消息。
events：指定应触发无头刷新的事件。
live_updates_notice_title：小部件标题
live_updates_notice_text：小部件描述文本
live_updates_notice_button：小部件按钮文本。

使用方法

基于事件的触发（可选）

要启用基于事件的触发，请在配置文件中将 event_trigger 设置为 true。这将根据指定的事件触发无头刷新。

仪表盘小部件

您可以通过包含其句柄 'headless-refresh' 来将 Headless Refresh 小部件添加到仪表盘。

isaadsalman / headless-refresh

维护者

详细信息