README

一个启动主题，有助于快速开始开发基于块的主题，同时附带许多面向开发者的功能。

了解文件夹结构 📂

 .
├── assets (Holds theme's assets)
│   └── src
│       └── js
│       └── css
├── bin (Holds scripts)
├── functions.php (PHP entry point)
├── inc
│   ├── classes (Holds all classes)
│   │   └── class-elementary-theme.php (Instantiates all of the classes)
│   ├── helpers (PHP Helpers)
│   │   └── custom-functions.php
│   └── traits (PHP Traits)
│       └── trait-singleton.php
├── index.php
├── parts (Block Template Parts)
├── patterns (Block Patterns)
│   ├── *.html
├── style.css
├── templates (Block Templates)
│   ├── *.html
├── tests (Holds JS & PHP tests)
│   ├── bootstrap.php
│   ├── js
│   └── php
└── theme.json

开始使用 🚀

方法 1（推荐）

composer create-project rtcamp/elementary [folder_name]

此命令等同于克隆存储库并运行 composer install && npm install

方法 2

使用以下命令手动克隆此存储库

git clone [URL to Git repo]

已克隆此存储库后，使用以下命令安装节点包和 PHP 依赖项

composer install

在这两种方法中，您将遇到一个主题设置向导，它将帮助您进行搜索替换。就这样！您现在可以开始构建您的块主题了。✨

注意：请参阅 .nvmrc 文件以检查运行此项目的支持 Node.js 版本。如果您的当前 Node.js 版本无法在本地主机上成功运行项目，请在终端上使用 Node 版本管理器配置正确的 Node.js 版本。

开发 💻

生产

npm run build:prod

监视更改

npm start

代码检查和格式化

检查 JS、CSS 和 PHP 代码。

npm run lint:js
npm run lint:css
npm run lint:php #phpcs

自动修复 JS、CSS 和 PHP 中可修复的代码检查错误。

npm run lint:js:fix
npm run lint:css:fix
npm run lint:php:fix #phpcbf

测试

运行所有测试。

npm run test

运行 JS 测试。

npm run test:js

监视 JS 测试。

npm run test:js:watch

运行 PHP 测试。

npm run test:php

rtcamp / elementary

维护者

详细信息