mdBook GitHub Actions 使用教程
1. 项目的目录结构及介绍
actions-mdbook/
├── __tests__/
│ └── ...
├── images/
│ └── ...
├── src/
│ └── ...
├── .dockerignore
├── .editorconfig
├── .envrc
├── .eslintrc.json
├── .gitignore
├── .nvmrc
├── .prettierrc.json
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── action.yml
├── jest.config.js
├── package-lock.json
├── package.json
├── release.sh
└── tsconfig.json
__tests__/
: 包含项目的测试文件。images/
: 包含项目使用的图片资源。src/
: 包含项目的主要源代码。.dockerignore
: Docker 构建时忽略的文件和目录。.editorconfig
: 编辑器配置文件,统一代码风格。.envrc
: 环境变量配置文件。.eslintrc.json
: ESLint 配置文件,用于代码检查。.gitignore
: Git 忽略的文件和目录。.nvmrc
: Node 版本管理配置文件。.prettierrc.json
: Prettier 配置文件,用于代码格式化。CHANGELOG.md
: 项目更新日志。LICENSE
: 项目许可证。Makefile
: Makefile 文件,用于自动化构建。README.md
: 项目说明文档。action.yml
: GitHub Actions 配置文件。jest.config.js
: Jest 测试框架配置文件。package-lock.json
: npm 依赖锁定文件。package.json
: npm 项目配置文件。release.sh
: 发布脚本。tsconfig.json
: TypeScript 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 action.yml
,这是 GitHub Actions 的配置文件。它定义了 Action 的输入、输出、运行环境等。
name: 'mdBook Action'
description: 'GitHub Actions for mdBook (rust-lang/mdBook)'
inputs:
mdbook-version:
description: 'mdBook version'
required: false
default: 'latest'
source:
description: 'Source directory'
required: false
default: '.'
dest:
description: 'Destination directory'
required: false
default: 'book'
runs:
using: 'docker'
image: 'Dockerfile'
branding:
icon: 'book'
color: 'blue'
3. 项目的配置文件介绍
Makefile
: 用于自动化构建任务。package.json
: 定义了项目的依赖和脚本。tsconfig.json
: TypeScript 编译配置。jest.config.js
: Jest 测试框架配置。.eslintrc.json
: ESLint 代码检查配置。.prettierrc.json
: Prettier 代码格式化配置。
这些配置文件共同确保了项目的构建、测试和代码质量。