Docgeni 文档生成器项目教程

Docgeni 文档生成器项目教程

docgeni 📖 A modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.（现代化的、强大的、开箱即用的 Angular 组件文档生成工具） 项目地址: https://gitcode.com/gh_mirrors/do/docgeni

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

Docgeni 是一个现代化的、强大的、开箱即用的 Angular 组件文档生成工具。以下是项目的目录结构及其简要介绍：

• docs: 存放项目的文档文件。
• examples: 包含示例代码和组件。
• packages: 项目的主要包，包括 @docgeni/cli, @docgeni/core, @docgeni/toolkit, @docgeni/template 等。
• scripts: 包含项目的脚本文件，用于执行各种构建和开发任务。
• test: 存放项目的测试文件。
• .circleci: CircleCI 的配置文件。
• .docgeni: Docgeni 的配置文件。
• .github: GitHub 工作流的配置文件。
• .husky: Husky 配置文件，用于 Git 钩子。
• .vscode: Visual Studio Code 的项目配置文件。
• angular.json: Angular 的项目配置文件。
• commitlint.config.js: 提交信息格式校验配置文件。
• eslint.config.mjs: ESLint 配置文件。
• karma.conf.js: Karma 测试框架的配置文件。
• lerna.json: Lerna 配置文件，用于管理多包仓库。
• package.json: 项目的主要配置文件，定义了项目的依赖、脚本和元数据。
• scss-bundle.config.json: SCSS 打包配置文件。
• tsconfig.json: TypeScript 配置文件。
• tsconfig.app.json: 应用程序的 TypeScript 配置文件。
• tsconfig.spec.json: 测试文件的 TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件，确保项目依赖的一致性。

2. 项目的启动文件介绍

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

• yarn start: 这个脚本用于启动文档的实时监控和本地服务。
• yarn build: 这个脚本用于构建所有的包。
• yarn build-deps: 这个脚本用于构建所有的依赖包。
• yarn build:docs: 这个脚本用于构建文档和站点项目。
• yarn test: 这个脚本用于运行测试用例。

3. 项目的配置文件介绍

以下是一些重要的配置文件及其用途：

• package.json: 这个文件包含了项目的依赖、脚本和元数据。它还定义了项目的入口点和其他相关信息。
• .docgeni: 这个目录包含了 Docgeni 的配置文件，用于定制文档生成过程。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译器的行为，包括编译选项、文件包含和排除规则等。
• karma.conf.js: Karma 配置文件，用于设置测试环境，包括测试框架、浏览器和报告器等。

通过以上配置文件，开发者可以定制化项目的构建、开发和测试流程，以满足不同的项目需求。

docgeni 📖 A modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.（现代化的、强大的、开箱即用的 Angular 组件文档生成工具） 项目地址: https://gitcode.com/gh_mirrors/do/docgeni