更纱黑体开源项目教程

更纱黑体开源项目教程

Sarasa-Gothic Sarasa Gothic / 更纱黑体 / 更紗黑體 / 更紗ゴシック / 사라사 고딕 项目地址: https://gitcode.com/gh_mirrors/sa/Sarasa-Gothic

1. 项目目录结构及介绍

更纱黑体项目是一个基于Inter、Iosevka和Source Han Sans的CJK组合字体。以下是项目的目录结构及其介绍：

• .github/: 存放GitHub工作流程文件。
• workflows/: 包含项目的自动化构建和测试流程。
• sources/: 源文件目录，包含字体的设计源文件。
• tools/: 存放字体构建和调整的工具脚本。
• .editorconfig: 用于配置代码编辑器的设置。
• .gitignore: 定义Git应该忽略的文件和目录。
• .npmignore: 定义NPM打包时应该忽略的文件和目录。
• .prettierrc.yaml: Prettier的配置文件，用于统一代码风格。
• LICENSE: 项目使用的许可证文件。
• README.md: 项目说明文件。
• README.zh_CN.md: 项目说明文件的中文版本。
• check-env.mjs: 检查环境需求的脚本。
• config.json: 项目配置文件。
• eslint.config.mjs: ESLint的配置文件，用于代码质量检查。
• package-lock.json: NPM包的锁定文件，确保依赖的一致性。
• package.json: NPM包的配置文件。
• verdafile.mjs: 可能是自定义的脚本文件。

2. 项目的启动文件介绍

项目的启动主要是通过NPM脚本进行的。以下是主要的启动文件介绍：

• package.json: 此文件中定义了NPM脚本，可以通过以下命令来构建字体：

  npm run build ttf
  

  该命令用于构建TTF格式的字体文件，构建后的文件会放在out/ttf目录下。

  若要构建TTC（字体集合）格式的文件，可以使用以下命令：

  npm run build ttc
  

  构建TTC文件需要大量的内存，因为包含了大量的子家族-正字法组合。

3. 项目的配置文件介绍

项目的配置主要通过config.json和.prettierrc.yaml文件进行。

• config.json: 此文件用于存储项目的配置信息，如字体的版本信息、构建选项等。
• .prettierrc.yaml: 此文件用于配置Prettier，它会帮助团队保持一致的代码风格，提高代码的可读性。

确保在开始构建之前，检查这些配置文件，确保它们符合你的需求。

Sarasa-Gothic Sarasa Gothic / 更纱黑体 / 更紗黑體 / 更紗ゴシック / 사라사 고딕 项目地址: https://gitcode.com/gh_mirrors/sa/Sarasa-Gothic