Chirpy Halo Theme 使用指南

1. 项目目录结构及介绍

Chirpy Halo Theme 的项目目录结构如下：

halo-theme-chirpy/
├── .github/               # GitHub 工作流和代码规范文件
├── i18n/                  # 国际化资源文件
├── src/                   # 源代码目录
│   ├── assets/            # 静态资源文件
│   ├── components/        # 主题组件
│   ├── layouts/           # 页面布局组件
│   ├── pages/             # 页面组件
│   ├── store/             # 状态管理
│   ├── themes/            # 主题样式
│   └── utils/             # 工具函数
├── templates/             # 模板文件
├── .editorconfig           # 编辑器配置文件
├── .eslintrc.cjs          # ESLint 配置文件
├── .gitignore             # Git 忽略文件
├── .prettierrc            # Prettier 配置文件
├── .stylelintrc.json      # Stylelint 配置文件
├── CODE_OF_CONDUCT.md     # 行为准则文件
├── LICENSE                # 许可证文件
├── README.md              # 项目说明文件
├── SECURITY.md            # 安全策略文件
├── annotation-setting.yaml # 注解配置文件
├── build.gradle           # Gradle 构建文件
├── export-zip.js          # 导出 Zip 文件的脚本
├── gradlew                # Gradle Wrapper 脚本
├── gradlew.bat            # Gradle Wrapper 脚本（Windows）
├── mode.js                # 模式设置脚本
├── package.json           # Node.js 项目配置文件
├── pnpm-lock.yaml         # pnpm 锁文件
├── prettier.config.js     # Prettier 配置文件
├── settings.gradle        # Gradle 设置文件
├── settings.yaml          # 设置文件
├── theme.yaml             # 主题配置文件
└── vite.config.js         # Vite 配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 文件中定义的脚本。以下是主要的启动脚本：

• start: 启动本地开发服务器。
• build: 构建生产环境的静态文件。

在项目的根目录下通过以下命令启动开发服务器：

npm run start

构建生产环境的静态文件，使用以下命令：

npm run build

3. 项目的配置文件介绍

以下是项目中的主要配置文件及其作用：

• .editorconfig: 用于定义代码风格规范，确保不同开发者的代码风格一致。
• .eslintrc.cjs: ESLint 配置文件，用于定义 JavaScript 代码的校验规则。
• .prettierrc: Prettier 配置文件，用于定义代码格式化的规则。
• .stylelintrc.json: Stylelint 配置文件，用于定义 CSS 样式的校验规则。
• settings.yaml: 主题的配置文件，用于定义主题的布局、样式等参数。
• theme.yaml: 主题的高级配置文件，包含主题的更多自定义选项。

确保在开始开发前，对以上配置文件进行适当的修改以符合项目的需求。