pantheon-systems/decoupled-preview

在包括Next.js的前端站点上预览WordPress内容

维护者

详细信息

github.com/pantheon-systems/wp-decoupled-preview

源代码

问题

安装次数: 2,437

依赖项: 0

建议者: 0

安全性: 0

星标: 7

关注者: 5

分支: 6

开放问题: 0

类型:wordpress-plugin

1.0.6 2024-05-02 14:18 UTC

Requires (Dev)

GPL-2.0-or-later 22cf98515eb9037aa0f2b3d7c0f94ea1c8cc1064

  • Pantheon <noreply.woop@pantheon.io>
  • abhisekmazumdar <abhisek.mazumdar.woop@pantheon.io>
  • Chris Reynolds <chris.reynolds.woop@pantheon.io>

This package is auto-updated.

Last update: 2024-09-11 15:07:16 UTC

README

Actively Maintained Packagist Version GPL 2.0 License Build Status

在您的前端站点上预览无头WordPress内容。

此插件旨在为各种解耦前端提供一个统一的预览平台。

功能

  • 编辑帖子/页面时预览。
  • 配置多个预览站点。
  • 指定每个预览站点应用的帖子类型（帖子和页面）。

配置

在WordPress管理仪表板上，转到 设置 -> 预览站点 (/wp-admin/options-general.php?page=preview_sites)，添加一个或多个预览站点，并配置以下内容

  • 标签：站点的名称。
  • URL：您提供的解耦站点的URL。
  • 密钥：一个令牌，将传递给您的解耦站点，用于限制预览的访问。
  • 预览类型：预览站点的类型 - 目前仅支持NextJS。
  • 内容类型：此预览站点应用的帖子类型（如帖子、页面）。

预览类型

虽然我们希望未来能够扩展，但此插件的初始版本仅支持NextJS。它是为了支持Pantheon的Next WordPress Starter而开发的，但可以使用类似的方法应用于其他NextJS站点。

已知问题

  • 目前此插件不支持自定义帖子类型。
  • 目前此插件不支持经典编辑器。

代码检查和测试

此插件使用Composer来管理依赖项。要从插件目录安装依赖项，请运行composer install。

使用PHP_CodeSniffer和Pantheon WP Coding Standards规则集进行代码检查。要运行代码检查，请使用以下命令

composer lint

单元测试使用PHPUnit和WP单元测试框架编写。要设置本地环境以运行单元测试，请使用以下命令

composer test:install

请注意，您需要在本地计算机上安装并运行MariaDB或MySQL。一旦设置了测试环境，您可以使用以下命令运行单元测试

composer test

代码检查和测试在每个提交和拉取请求上通过GitHub Action执行。测试位于tests目录中。