YAMLResume 项目启动与配置教程

1. 项目目录结构及介绍

YAMLResume 是一个将简历内容以 YAML 格式编写，并生成专业 PDF 文档的开源项目。以下是项目的目录结构及各部分功能的简要介绍：

yamlresume/
├── .github/          # GitHub 工作流和钩子配置
├── .husky/           # Husky 钩子配置，用于执行预处理任务
├── docs/             # 项目文档
├── images/           # 存储项目文档中使用的图片
├── packages/         # 存储与项目相关的包
├── .editorconfig      # 编辑器配置文件
├── .gitattributes     # Git 属性配置
├── .gitignore         # Git 忽略文件
├── .npmignore         # npm 忽略文件
├── .tokeignore        # Token 忽略文件
├── CHANGELOG.md       # 项目更新日志
├── CONTRIBUTING.md    # 贡献指南
├── LICENSE            # 项目许可证
├── README.md          # 项目自述文件
├── biome.json         # 项目配置文件
├── commitlint.config.mjs # 提交信息校验配置
├── package.json       # 项目包配置文件
├── pnpm-lock.yaml      # pnpm 锁文件
├── pnpm-workspace.yaml # pnpm 工作空间配置
├── tsconfig.base.json # TypeScript 配置文件
├── tsup.config.base.ts # Tsup 配置文件
└── vitest.config.base.mts # Vitest 配置文件

2. 项目的启动文件介绍

YAMLResume 的启动主要是通过命令行工具进行的。在安装了项目全局依赖之后，可以通过以下命令创建和构建简历：

• 创建新简历：

  yamlresume new my-resume.yml
  

• 构建简历生成 PDF：

  yamlresume build my-resume.yml
  

在执行上述命令之前，需要确保已经安装了全局的 yamlresume 包。可以使用 npm、yarn 或 pnpm 进行安装：

npm install -g yamlresume
# 或者
yarn global add yamlresume
# 或者
pnpm add -g yamlresume

3. 项目的配置文件介绍

YAMLResume 的配置主要通过以下文件进行：

• .editorconfig：编辑器配置文件，用于统一不同开发者的代码风格。
• .gitattributes：Git 属性配置文件，用于定义如何处理特定类型的文件。
• .gitignore：Git 忽略文件，用于指定 Git 忽略跟踪的文件和目录。
• .npmignore：npm 忽略文件，用于指定发布到 npm 时应忽略的文件。
• tsconfig.base.json：TypeScript 配置文件，用于配置 TypeScript 编译选项。
• tsup.config.base.ts：Tsup 配置文件，用于配置 TypeScript 打包选项。
• vitest.config.base.mts：Vitest 配置文件，用于配置测试框架。

项目中的其他配置文件如 package.json 和 pnpm-workspace.yaml 等用于管理项目的依赖和脚本。此外，biome.json 是项目的自定义配置文件，可能包含了特定的项目设置。

确保根据项目需要和开发环境正确配置上述文件，以便项目能够顺利运行。