README

一个开发者友好的启动主题，用于创建Genesis框架的商业子主题。

它使用Composer来引入Core组件库，该库为主题配置提供PHP逻辑，并使用Gulp WP Toolkit来自动化编译SCSS和压缩图像等日常构建任务。

查看实时演示

目录

• 功能
• 要求
• 安装
  • 单行命令
  • 单独命令
• 设置
• 使用
• 开发
• 结构
• 贡献
• 作者
• 特别感谢

功能

Base旨在现代化、组织和增强Genesis子主题开发的一些方面。看看等待你的是什么

• Bourbon作为一个轻量级的Sass工具包
• Gulp用于自动化开发构建任务
• Browsersync用于同步浏览器测试
• 基于配置的，面向对象的模块化架构
• CLI设置脚本以自动更新信息
• Yarn或NPM用于管理Node依赖
• Composer用于管理PHP依赖
• PSR-4类自动加载
• 命名空间化以避免命名冲突

要求

安装

单行命令

使用Composer从您的WordPress主题目录安装Base的最新开发版本（将下面的your-theme-name替换为您主题的名称）

composer create-project seothemes/base your-theme-name dev-master && cd "$(\ls -1dt ./*/ | head -n 1)" && sh setup.sh

单独命令

使用Composer从您的WordPress主题目录安装Base的最新开发版本（将下面的your-theme-name替换为您主题的名称）

composer create-project seothemes/base your-theme-name dev-master

导航到主题的根目录

cd your-theme-name

运行设置脚本以重命名主题、构建主题资产并启动Browsersync

sh setup.sh

设置

Base包括一个强大的设置脚本，可自动更新主题详细信息的过程

它将以下详细信息替换为您自己的

• 主题名称
• 主题文本域
• 主题作者
• 主题作者URL
• 主题开发URL
• 主题命名空间
• 主题版本

使用

Base旨在与SEO Themes Core一起使用。所有对子主题的更改都应通过主题配置文件进行。这可以用来更改主题的几乎所有方面，包括主题功能、导航菜单、图像大小、小工具区域等。本主题附带一个示例配置文件。

组件仅在提供配置密钥时加载。根据项目需求可以添加或删除组件。例如，要删除PluginActivation组件，只需从config/defaults.php中的返回语句中删除其配置密钥即可。

为了提供额外的功能，项目目录 app 用于存放特定项目的 PHP 文件。它预先配置了 PSR-4 自动加载。可以通过创建一个扩展 Component 类的类来创建自定义组件，然后将它的配置添加到主题的配置文件中，就像创建其他核心组件一样。主题中包含了一个 示例组件 以供您开始。

主题的详细信息，如主题名称、作者、版本号等，应仅从 package.json 文件中进行更改。Gulp 构建任务读取此文件，并自动将相关信息放置到主题的正确位置。

静态资源组织在 resources 目录中。此文件夹包含主题脚本、样式、图像、字体、视图和语言翻译文件。

开发

有关可用构建任务的完整列表，请参阅 Gulp WP Toolkit 指令。

除了 Gulp WP Toolkit 的任务外，还有一个 zip 任务，可以用来生成主题的存档，包括必需的 composer 包文件，而不包括不必要的文件。可以通过 Gulpfile 中的 toolkit.extendConfig.src.zip 配置修改包含文件的列表。

结构

your-theme-name/    # → Root directory
├── app/            # → Theme PHP files
│   └── Example.php # → Example component
├── config/         # → Config directory
│   └── config.php  # → Theme settings
├── resources/      # → Front-end assets
│   ├── fonts/      # → Theme fonts
│   ├── img/        # → Theme images
│   ├── js/         # → Theme JavaScript
│   ├── lang/       # → Translation files
│   ├── scss/       # → Sass partials
│   └── views/      # → Theme templates
├── node_modules/   # → Node.js packages
├── vendor/         # → Composer packages
├── composer.json   # → Composer settings
├── functions.php   # → Composer autoloader
├── front-page.php  # → Front page template
├── Gulpfile.js     # → Gulp config
├── package.json    # → Node dependencies
├── screenshot.png  # → Theme screenshot
├── setup.sh        # → CLI setup script
├── style.css       # → Theme stylesheet
└── woocommerce.css # → WooCommerce styles

贡献

欢迎所有人贡献。我们有一些 贡献指南 来帮助您开始。

作者

查看参与此项目的 贡献者列表。

特别感谢

向使用了或为该项目提供灵感的任何人的代码致敬。

Craig Simpson，Christoph Herr，Gary Jones，Tim Jensen，Bill Erickson，Sridhar Katakam，Nathan Rice，Brian Gardner