Sage 框架安装与使用教程
1. 项目目录结构及介绍
Sage 是一个基于 WordPress 的主题框架,其目录结构通常如下:
sage/
├── composer.json # Composer 配置文件
├── package.json # npm 包管理文件
├── sage/ # 主题核心文件夹
│ ├── assets/ # 资源文件(CSS, JS, Images 等)
│ │ └── js/ # JavaScript 文件
│ ├── inc/ # PHP 函数和类库
│ ├── index.php # 主题入口文件
│ ├── style.css # 样式表
│ └── template-parts/ # 可重用模板部分
└── theme.php # 主题设置和钩子
assets
: 存放前端资源,包括 CSS 和 JavaScript 文件。inc
: 存储自定义函数和类,用于扩展 WordPress 功能。index.php
: 主题的基础入口文件,WordPress 会从这里加载主题。style.css
: 主题的主要样式表文件。template-parts
: 包含可复用的页面组件或模板。theme.php
: 主题的设置和钩子,可以在此添加自定义功能。
2. 项目的启动文件介绍
Sage 使用 Composer 和 npm 进行管理和构建。启动流程如下:
2.1 安装依赖
首先,确保你已安装了 Composer 和 Node.js。在项目根目录执行以下命令来安装依赖:
composer install
npm install
2.2 设置 WordPress
将 Sage 目录上传到你的 WordPress wp-content/themes
目录中并启用该主题。在 WordPress 后台的主题区域,你会看到 Sage 主题可供选择。
3. 项目的配置文件介绍
3.1 composer.json
此文件用于定义项目的依赖关系以及 Composer 应如何处理这些依赖。你可以在这里添加或移除对其他 WordPress 插件或库的依赖。
3.2 package.json
这个文件用于管理前端构建工具(如 Webpack)的依赖。它还包含了有关项目的信息,如版本、作者等,以及构建脚本。例如,你可以运行 npm run build
来编译前端资产。
3.3 theme.php
在这个文件里,你可以定义主题的初始化设置,注册小工具、菜单、侧边栏等,以及添加自定义的函数和操作钩子。它是 Sage 自定义功能的核心。
现在你已经对 Sage 框架有了基础了解,可以根据需要进行代码编辑和定制,以创建自己的 WordPress 主题。记得每次更新前端代码后运行构建命令,以保持 assets 文件夹内有最新的打包文件。祝你在 Sage 中开发愉快!