README

Sage-9-Timber 是针对 Sage 主题 版本 9 进行修改，以便与 Timber 一起使用。

为了便于集成和后期兼容性，此存储库旨在对原始 Sage 9 beta 4 进行尽可能少的修改，以便使 Timber 能够工作。此主题仍然支持 twig 模板语言。

Sage 9 正在积极开发中，目前处于测试阶段。这个初始分支使用了 Sage 9 beta 4 版本。如果您想查看将 Sage 移植到 Timber 的稳定版本，请查看 sage-timber 项目。

Bedrock 特定安装

您必须在 Bedrock 项目的根目录中的 composer.json 中实现以下内容。否则，由于它期望它们相对于主题 composer 自动加载器加载，SageController 包将不会加载您的控制器。

"autoload": {
    "psr-4": {
        "App\\": "web/app/themes/<child-theme>/app/"
    }
},

功能

• Sass 用于样式表
• ES6 用于 JavaScript
• Webpack 用于编译资源，优化图像，以及连接和压缩文件
• Browsersync 用于同步浏览器测试
• Twig 作为模板引擎
• Controller 用于将数据传递到 Blade 模板
• CSS 框架选项
  • Bootstrap 4
  • Bulma
  • Foundation
  • Tachyons
  • 无（空白石板）
• Font Awesome（可选）

请参阅工作示例 roots-example-project.com。

要求

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

• Timber 作为 WordPress 插件
• WordPress >= 4.7
• PHP >= 7.0
• Composer
• Node.js >= 6.9.x
• Yarn

主题安装

通过将项目复制到 WordPress 主题目录中的新文件夹中来安装 Sage-9-timber。

主题结构

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         # → Actions and theme options
│   └── timber.php        # → Timber init
├── 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 Timber templates
│       └── templates/    # → Timber twig templates
└── vendor/               # → Composer packages (never edit)

主题设置

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

主题开发

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

构建命令

• yarn run start — 当文件更改时编译资源，开始 Browsersync 会话
• yarn run build — 编译并优化您的资源目录中的文件
• yarn run build:production — 编译生产资源

文档

Timber 文档可在 https://timber.github.io/docs/ 获取。

Twig 文档可在 http://twig.sensiolabs.org/ 获取。

Sage 9 文档正在编制中，可以在以下链接查看：https://github.com/roots/docs/tree/sage-9/sage。

控制器文档可在以下链接查看：https://github.com/soberwp/controller#usage。

贡献

欢迎任何人贡献。只需向本仓库发起一个拉取请求。

Sage 社区

关注开发和社区新闻。

• 在Roots Discourse上参与讨论
• 关注Twitter上的@rootswp
• 阅读并订阅Roots 博客
• 订阅Roots 电子邮件通讯
• 收听Roots Radio播客