htmldocs 项目使用教程

1. 项目目录结构及介绍

htmldocs 项目是一个基于 React、TypeScript 和 Tailwind 的现代化文档编辑和预览服务，用于创建 PDF 文件。以下是项目的目录结构及其简要介绍：

htmldocs/
├── apps/                        # 应用程序目录
├── packages/                     # 项目包目录
├── .github/                      # GitHub 工作流和配置
├── .vscode/                      # Visual Studio Code 配置
├── scripts/                      # 脚本目录
├── public/                       # 公共资源目录
├── src/                           # 源代码目录
├── README.md                      # 项目说明文档
├── LICENSE                        # 项目许可证
└── package.json                   # 项目配置文件

2. 项目的启动文件介绍

项目的启动主要通过 package.json 文件中定义的脚本进行。以下是一些主要的启动脚本：

• start: 用于启动本地开发服务器。
• build: 用于构建项目生产环境的静态文件。
• serve: 用于启动静态文件服务器来预览构建结果。

你可以通过以下命令启动开发服务器：

npm start
# 或者
yarn start

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• package.json: 定义了项目的依赖、脚本和元数据。
• .eslintrc.js: ESLint 配置文件，用于定义代码风格和规则。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译器的选项。
• vitest.config.ts: Vitest 配置文件，用于定义测试环境和配置。
• turbo.json: Turborepo 配置文件，用于优化 monorepo 的工作流。

这些配置文件确保了代码的规范性、类型安全性和项目的优化构建。在开始项目之前，确保所有配置文件都已经根据项目需求进行了适当的设置和调整。