frederikthinkcomplex/mdbook-rust-alpine

mdBook静态网页生成Docker镜像

镜像概述

本Docker镜像集成了Rust语言的mdBook工具链，提供一站式环境用于将Markdown文档转换为结构清晰、交互友好的静态网页。mdBook是轻量级静态站点生成器，专注于文档网站、电子书及技术手册的构建，无需本地配置复杂依赖即可快速生成可直接部署的静态内容。

核心功能

• 完整工具链集成：包含最新稳定版mdBook及所有依赖组件
• 零本地配置：无需在主机安装Rust环境及相关工具链
• Markdown全面支持：兼容标准Markdown语法及扩展功能（代码块、表格、数学公式等）
• 响应式输出：生成的网页自动适配桌面端与移动端
• 开发模式支持：内置实时预览功能，修改文档后自动刷新页面

适用场景

• 技术文档网站构建（API文档、产品手册、使用指南）
• 开源项目文档管理与在线发布
• 个人/团队知识库静态化部署
• 电子书、教程或培训材料的网页化呈现
• 需要快速将Markdown文档转换为可访问网页的场景

使用方法

基本工作流程

1. 准备Markdown文档及目录结构
2. 通过容器初始化项目（可选）
3. 构建静态网页文件
4. 部署生成的静态文件至Web服务器

Docker命令示例

初始化mdBook项目

在当前目录创建基础项目结构（包含src目录和book.toml配置文件）：

bash
docker run --rm -v $(pwd):/book [镜像名称] mdbook init

构建静态网页

将Markdown文档编译为静态HTML文件（输出至./book目录）：

bash
docker run --rm -v $(pwd):/book [镜像名称] mdbook build

启动开发服务器（实时预览）

运行本地服务器（默认端口3000），实时预览文档并支持热重载：

bash
docker run --rm -v $(pwd):/book -p 3000:3000 [镜像名称] mdbook serve --hostname 0.0.0.0

访问 http://localhost:3000 即可查看实时预览效果。

目录结构说明

容器内工作目录为/book，需将本地项目目录挂载至此路径。标准项目结构：

/book
├── book.toml       # 项目配置文件
└── src             # Markdown文档目录
    ├── SUMMARY.md  # 文档导航结构
    ├── chapter_1.md
    └── ...

配置自定义

通过修改book.toml文件可定制网站标题、作者、主题等参数，示例配置：

toml
[book]
title = "我的技术文档"
author = "文档作者"
description = "使用mdBook生成的静态文档"

[output.html]
theme = "rust"  # 内置主题：rust、coal、navy、ayu
default-theme = "light"

部署说明

生成的静态文件位于本地./book目录，可直接部署至任何静态Web服务器（如Nginx、Apache、GitHub Pages、Netlify等）。