hrektts/mdbook

docker-mdbook

镜像概述

这是一个包含https://github.com/azerupi/mdBook%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82mdBook%E6%98%AF%E4%B8%80%E4%B8%AA%E8%BD%BB%E9%87%8F%E7%BA%A7%E5%B7%A5%E5%85%B7%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%88%9B%E5%BB%BA%E5%92%8C%E7%AE%A1%E7%90%86%E5%9F%BA%E4%BA%8EMarkdown%E7%9A%84%E4%B9%A6%E7%B1%8D%E3%80%82%E9%80%9A%E8%BF%87%E5%AE%B9%E5%99%A8%E5%8C%96%E6%96%B9%E5%BC%8F%EF%BC%8C%E5%8F%AF%E4%BE%BF%E6%8D%B7%E4%BD%BF%E7%94%A8mdBook%E7%9A%84%E5%90%84%E9%A1%B9%E5%8A%9F%E8%83%BD%EF%BC%8C%E9%81%BF%E5%85%8D%E6%9C%AC%E5%9C%B0%E7%8E%AF%E5%A2%83%E9%85%8D%E7%BD%AE%E5%86%B2%E7%AA%81%E3%80%82

![Travis Build Status]([***]

核心功能和特性

• 集成完整的mdBook工具链，支持书籍初始化、构建和预览
• 容器化运行，无需在本地安装mdBook及其依赖
• 支持挂载本地目录，实现书籍文件的持久化存储和编辑
• 提供交互式命令行，方便执行mdBook的各类操作

使用场景和适用范围

适用于需要创建技术文档、教程或电子书的开发者、作者和教育工作者。特别适合跨平台协作、快速部署mdBook环境或需要隔离开发环境的场景。

使用方法和配置说明

基本命令格式

shell
docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) -it hrektts/mdbook [mdbook命令]

参数说明：

• --rm：容器退出后自动删除
• -v $(pwd):/data：将当前目录挂载到容器内的/data目录，用于书籍文件的读写
• -u $(id -u):$(id -g)：指定运行用户ID和组ID，避免文件权限问题
• -it：启用交互式终端，支持命令行输入
• hrektts/mdbook：镜像名称
• [mdbook命令]：mdBook的具体操作命令（如init、build、serve等）

常用命令示例

1. 初始化书籍

shell
cd /path/to/book  # 进入书籍存放目录
docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) -it hrektts/mdbook mdbook init

该命令会在当前目录初始化一个新的mdBook项目，生成必要的目录结构（如src目录）和配置文件（book.toml）。

2. 构建书籍

shell
docker run --rm -v $(pwd):/data -u $(id -u):$(id -g) -it hrektts/mdbook mdbook build

将Markdown文件构建为静态HTML，输出到当前目录下的book文件夹。

3. 本地预览书籍

shell
docker run --rm -p 3000:3000 -p 3001:3001 -v $(pwd):/data -u $(id -u):$(id -g) -it hrektts/mdbook mdbook serve -p 3000 -n 0.0.0.0

启动本地服务器预览书籍，通过http://localhost:3000访问。
端口说明：

• 3000：HTTP服务端口，用于访问书籍预览页面
• 3001：WebSocket端口，用于实时监测文件变化并自动刷新页面

执行命令后，修改Markdown文件会自动触发重新构建，浏览器页面实时更新。