Yomichan 项目教程

1. 项目的目录结构及介绍

Yomichan 项目的目录结构如下：

yomichan/
├── dev/
├── docs/
├── ex/
├── img/
├── resources/
├── test/
├── .eslintignore
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .htmlvalidate.json
├── .htmlvalidateignore
├── .stylelintignore
├── .stylelintrc.json
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── build.bat
├── build.sh
├── package-lock.json
├── package.json

目录介绍

• dev/: 开发相关文件。
• docs/: 项目文档。
• ex/: 示例文件。
• img/: 图片资源。
• resources/: 资源文件。
• test/: 测试文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.json: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .htmlvalidate.json: HTML 验证配置文件。
• .htmlvalidateignore: HTML 验证忽略文件。
• .stylelintignore: Stylelint 忽略文件。
• .stylelintrc.json: Stylelint 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• build.bat: Windows 构建脚本。
• build.sh: Unix/Linux 构建脚本。
• package-lock.json: npm 锁定文件。
• package.json: npm 配置文件。

2. 项目的启动文件介绍

Yomichan 项目的启动文件主要是 build.bat 和 build.sh。这两个文件分别用于在 Windows 和 Unix/Linux 系统上构建项目。

build.bat

这是一个 Windows 批处理脚本，用于在 Windows 系统上构建项目。它通常会执行以下操作：

• 安装依赖项
• 编译代码
• 打包项目

build.sh

这是一个 Unix/Linux shell 脚本，用于在 Unix/Linux 系统上构建项目。它通常会执行以下操作：

• 安装依赖项
• 编译代码
• 打包项目

3. 项目的配置文件介绍

Yomichan 项目中有多个配置文件，用于不同的配置需求。

.eslintrc.json

ESLint 配置文件，用于定义代码风格和规则。

.stylelintrc.json

Stylelint 配置文件，用于定义 CSS/SCSS 代码风格和规则。

.htmlvalidate.json

HTML 验证配置文件，用于定义 HTML 文件的验证规则。

package.json

npm 配置文件，包含项目的元数据和依赖项。它定义了项目的名称、版本、作者、依赖项等信息。

README.md

项目说明文档，包含项目的介绍、安装步骤、使用方法等信息。

LICENSE

项目许可证，定义了项目的开源许可证类型。

CONTRIBUTING.md

贡献指南，指导开发者如何为项目贡献代码。

这些配置文件共同确保了项目的代码质量和一致性，同时也方便了开发者进行项目的构建和维护。