peaceiris/mdbook

镜像概述

peaceiris/mdbook是一个基于Alpine Linux的Docker镜像，专为mdBook（一款轻量级Markdown文档生成工具）设计。该镜像旨在提供轻量级、跨架构的运行环境，用于构建、管理和部署mdBook格式的文档项目。镜像发布流程通过GitHub Actions自动化，确保版本更新及时，并在GitHub Packages提供镜像下载。

核心功能与特性

• 轻量级基础：基于Alpine Linux构建，镜像体积小，资源占用低
• 多架构支持：兼容amd64（x86_64）和arm64（AArch64）CPU架构，适用于不同硬件环境
• 自动化发布：通过GitHub Actions实现版本发布流程自动化，保证镜像更新的及时性和可靠性
• 原生工具集成：内置mdBook工具，支持标准mdBook命令（如build、serve、watch等）

使用场景

• 本地文档开发：快速搭建mdBook开发环境，无需手动安装依赖，直接构建和预览Markdown文档
• CI/CD流程集成：在持续集成/持续部署管道中自动构建文档，实现文档与代码的同步发布
• 跨平台部署：适用于amd64服务器、ARM开发板等不同架构设备的文档构建需求

使用方法

镜像获取

可从GitHub Packages拉取最新版本镜像：

bash
docker pull ***-ghcr.xuanyuan.run/peaceiris/mdbook

基本使用示例

构建mdBook文档

在本地mdBook项目目录中执行以下命令，构建文档输出到book目录：

bash
docker run --rm -v $(pwd):/book ***-ghcr.xuanyuan.run/peaceiris/mdbook mdbook build

实时预览文档

启动本地服务器，实时预览文档（默认端口4000）：

bash
docker run --rm -v $(pwd):/book -p 4000:4000 ***-ghcr.xuanyuan.run/peaceiris/mdbook mdbook serve --hostname 0.0.0.0

查看mdBook版本

验证镜像中mdBook的版本：

bash
docker run --rm ***-ghcr.xuanyuan.run/peaceiris/mdbook mdbook --version

相关链接

• 项目源码与详细文档：https://github.com/peaceiris/docker-mdbook
• 镜像下载地址：https://github.com/users/peaceiris/packages/container/package/mdbook