README

Twenty'em WordPress 框架

什么是 Twenty'em?

Twenty'em 是一个专为 WordPress 开发子主题而设计的主题/框架，它具有丰富的配置选项和开发 API，既可以用于简单的项目，也可以用于大型项目。

安装

手册

Twenty'em 的安装方式与任何其他 WordPress 主题相同。您需要下载最新版本，解压缩 .zip 文件，并将其内容复制到您的 WordPress 安装目录下的 /wp-content/themes/。或者您也可以使用 WordPress 主题安装器上传它。

通过 Git 安装

您可以直接从 GitHub 克隆仓库

$ cd /path/to/your/wordpress-site/wp-content/themes/
$ git clone https://github.com/rogertm/twenty-em.git

通过 Composer 安装

$ cd /path/to/your/wordpress-site/
$ composer require rogertm/twenty-em:^1.0

或者您可以直接安装 Twenty'em 子主题，它将自动安装 Twenty'em。

$ cd /path/to/your/wordpress-site/
$ composer require rogertm/twenty-em-child:^1.0

依赖

Twenty'em 需要一些依赖项，您需要通过 npm 安装它们。您需要在计算机上预先安装 Node.js。从您的 CLI 执行以下命令：

$ cd /path/to/your/wordpress-site/wp-content/themes/twenty-em/
$ npm install
$ gulp

如果您使用的是子主题，您还必须部署编译子主题 scss 文件的必要任务。从同一 twenty-em 目录执行以下命令：

$ gulp child

您还可以执行 gulp watch 和 gulp watch:child 来编译您工作的 scss 和 js 文件。 此命令在很大程度上取决于环境变量。请参阅下面的更多信息。

环境变量 (.env)

为了使通过 gulp 执行的任务正常运行，必须在名为 .env 的文件中定义必要的环境变量。

变量名称	可能的值	描述
`DEV_MODE`	`true`, `false`	如果设置为 `false`，则所有编译的文件都将被压缩
`CHILD_THEME_EXISTS`	`true`, `false`	如果已安装子主题，则评估为 `true`
`CHILD_THEME`	`../child-theme-dir`	子主题目录的名称（如果以斜杠结尾）

管理面板

Twenty'em 提供了一个 管理面板，您可以通过它以最小的努力来配置您站点的结构。

从此面板您可以访问帮助，其中简要说明了如何在每个情况下操作以及每个选项的作用。

此管理面板的操作非常简单直观，如果每个选项面板有子选项，允许同一模块有多种行为，那么将选择通过激活相应子选项的选项卡来选择。

配置所有选项后，您需要单击保存更改以保存您所做的所有配置。

备份管理员

在Twenty'em的管理面板中进行所有配置后，您可以导出一个.txt文件，然后可以将其用于在需要恢复所有选项集的情况下导入这些配置。甚至，配置使用Twenty'em制作的另一个网站。

为此，您需要访问Twenty'em > 备份，在那里您将找到我们简单的备份管理员。

导出

您可以导出配置，以便再次恢复或复制到其他位置。如果一个Child Theme或Plugin将其配置与wp_options表中的t_em_theme_options选项合并，这些选项也将被导出到同一.txt文件中。

选项将被导出到一个名为t-em-backup-的文件中，后面跟导出时的日期和时间。例如：t-em-backup-Ymd-His.txt。

导入

您可以导入之前导出的文件，这将更新数据库中wp_options表的t_em_theme_options选项。

重要：只有通过备份管理员生成的文件才能重新导入。此操作无法撤销。

小部件、模板和短代码

Twenty'em默认提供了一系列元素，这些元素可以帮助您更好地管理项目中的内容。

小部件

除了WordPress的内置小部件外，Twenty'em还带来了一些新小部件，这些小部件将改善您的项目的视觉效果和结构，包括作者、图片画廊、最新帖子、热门帖子、评论，以及一个非常有用的小部件，允许您的客户或用户通过FeedBurner订阅。

模板

在WordPress中，模板或页面模板是通过文件创建页面的方式，但它们具有与标准页面不同的特性或行为。Twenty'em提供了一系列这些模板，其中包括档案、作者、网站地图等。

短代码

短代码是一系列小型的宏代码，可以插入到编辑器中，并执行开发者创建的函数。Twenty'em提供了一系列这些短代码，让您能够格式化您的文章。包括警报、引言、图标、按钮等，它们还拥有多个选项。

开发API

Twenty'em主要基于钩子的使用，这使该框架的开发具有极高的灵活性和可扩展性。此外，我们还提供了一系列函数（如辅助函数），目的是方便开发者工作，当然还有变量、常量等。

注意：目前我们正在对这一部分进行文档编制。

许可协议

与WordPress一样，Twenty'em是一款开源免费的软件，根据GPLv2（或更高版本）许可协议进行分发。您可以在Twenty'em的每个版本中找到许可协议的副本，我们也为西班牙语用户提供了一个非官方的西班牙语版本。

同样，从本站分发的所有由Twenty'em衍生出的软件（插件、模块、代码等）都将继承该许可协议。

捐赠

我们多年来一直在开发Twenty'em框架，现在将它与你分享。我们非常感激你想要对我们的贡献，这样我们才能保持我们的项目。谢谢。

进行捐赠

rogertm / twenty-em

维护者

详细信息