GitHub Actions for mdBook：自动化你的文档构建与部署-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00644/article/details/141854284

GitHub Actions for mdBook：自动化你的文档构建与部署

actions-mdbookGitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.项目地址:https://gitcode.com/gh_mirrors/ac/actions-mdbook

项目介绍

GitHub Actions for mdBook 是一个专为 mdBook 设计的 GitHub Actions 工作流。mdBook 是一个由 Rust 编写的工具，用于创建现代、响应式的电子书。通过这个 GitHub Actions，用户可以在 GitHub Actions 的虚拟机上运行 mdBook，支持 Linux、macOS 和 Windows 平台。

项目技术分析

技术栈

mdBook: 一个强大的文档构建工具，支持 Markdown 格式。
GitHub Actions: GitHub 提供的自动化工作流服务，用于持续集成和持续部署。

核心功能

跨平台支持: 支持 Ubuntu、macOS 和 Windows。
版本控制: 可以指定 mdBook 的版本，或使用最新版本。
自动化部署: 集成 GitHub Pages，实现文档的自动构建和部署。

项目及技术应用场景

应用场景

技术文档编写: 适用于开发者编写技术文档，如 API 文档、项目文档等。
电子书制作: 用于制作电子书，支持响应式设计和多平台阅读。
持续集成与部署: 通过 GitHub Actions，实现文档的自动构建和部署，提高开发效率。

示例

以下是一个简单的 GitHub Actions 工作流示例，用于在 push 到 main 分支时自动构建和部署 mdBook 文档：

name: github pages

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  deploy:
    runs-on: ubuntu-20.04
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v2

      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v1
        with:
          mdbook-version: '0.4.10'
          # mdbook-version: 'latest'

      - run: mdbook build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./book