README

Sage 是一个具有现代开发工作流程的 WordPress 起始主题。

特性

• 用于样式表的 Sass
• 现代 JavaScript
• Webpack 用于编译资源，优化图片，以及合并和压缩文件
• Browsersync 用于同步浏览器测试
• Blade 作为模板引擎
• Controller 用于将数据传递给 Blade 模板
• CSS 框架（可选）: Bootstrap 4, Bulma, Foundation, Tachyons, Tailwind

在 roots-example-project.com 查看工作示例。

要求

在继续之前，请确保已安装所有依赖项

• WordPress >= 4.7
• PHP >= 7.1.3（已启用 php-mbstring）
• Composer
• Node.js >= 8.0.0
• Yarn

主题安装

使用 Composer 从您的 WordPress 主题目录安装 Sage（以下代码中的 your-theme-name 用您的主题名称替换）

# @ app/themes/ or wp-content/themes/
$ composer create-project roots/sage your-theme-name

要安装 Sage 的最新开发版本，请将 dev-master 添加到命令末尾

$ composer create-project roots/sage your-theme-name dev-master

在主题安装过程中，您可以选择更新 style.css 主题标题，选择 CSS 框架，并配置 Browsersync。

主题结构

themes/your-theme-name/   # → Root of your Sage based theme
├── app/                  # → Theme PHP
│   ├── Controllers/      # → Controller files
│   ├── admin.php         # → Theme customizer setup
│   ├── filters.php       # → Theme filters
│   ├── helpers.php       # → Helper functions
│   └── setup.php         # → Theme setup
├── composer.json         # → Autoloading for `app/` files
├── composer.lock         # → Composer lock file (never edit)
├── dist/                 # → Built theme assets (never edit)
├── node_modules/         # → Node.js packages (never edit)
├── package.json          # → Node.js dependencies and scripts
├── resources/            # → Theme assets and templates
│   ├── assets/           # → Front-end assets
│   │   ├── config.json   # → Settings for compiled assets
│   │   ├── build/        # → Webpack and ESLint config
│   │   ├── fonts/        # → Theme fonts
│   │   ├── images/       # → Theme images
│   │   ├── scripts/      # → Theme JS
│   │   └── styles/       # → Theme stylesheets
│   ├── functions.php     # → Composer autoloader, theme includes
│   ├── index.php         # → Never manually edit
│   ├── screenshot.png    # → Theme screenshot for WP admin
│   ├── style.css         # → Theme meta information
│   └── views/            # → Theme templates
│       ├── layouts/      # → Base templates
│       └── partials/     # → Partial templates
└── vendor/               # → Composer packages (never edit)

主题设置

编辑 app/setup.php 以启用或禁用主题功能，设置导航菜单，帖子缩略图大小和侧边栏。

主题开发

• 从主题目录运行 yarn 以安装依赖项
• 更新 resources/assets/config.json 设置
  • devUrl 应反映您的本地开发主机名
  • publicPath 应反映您的 WordPress 文件夹结构（非 Bedrock 安装为 /wp-content/themes/sage）

构建命令

• yarn start — 当文件更改时编译资源，启动 Browsersync 会话
• yarn build — 编译和优化 assets 目录中的文件
• yarn build:production — 编译生产资源

文档

• Sage 文档
• Controller 文档

贡献

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

Sage 赞助商

通过 成为赞助商 来帮助我们支持开源开发工作。

社区

跟踪开发和社区新闻。

• 参与Roots Discourse
• 关注Rootswp在Twitter上的动态：@rootswp
• 阅读并订阅Roots博客：Roots Blog
• 订阅Roots通讯：Roots Newsletter
• 收听Roots Radio播客：Roots Radio podcast