- 📝 **模块化文档**: 将运维文档拆分为独立模块（架构、日常运维、故障处理等） - 🎨 **多客户支持**: 为不同客户配置专属的文档组合和元数据 - 🔧 **自动化构建**: 通过 Web 界面一键生成 Word 或 PDF 文档 - 📄 **PDF 输出**: 支持 PDF 格式输出，含代码高亮、封面、目录等专业排版 - 🌐 **Web 界面**: 提供可视化界面，选择客户和文档类型即可生成 注意：应用内置了模板用于测试，实际可按照使用手册对应修改，PDF示例可用于pdf输出测试，其余请用word输出测试。 ### Step 1: 首次启动 应用首次启动时会自动初始化以下目录： - `/app/src` - 文档源文件（Markdown 格式） - `/app/clients` - 客户配置目录 - `/app/templates` - Word 模板目录 - `/app/build` - 输出目录 初始化过程约需 10-30 秒，请耐心等待。 ### Step 2: 访问 Web 界面 打开浏览器访问应用 Web 界面功能： - 选择客户和文档类型 - 选择输出格式（Word/PDF） - 一键生成并下载文档 - 创建新客户配置 ### Step 3: 添加自定义文档 1. **添加文档模块**: 将 Markdown 文件放入 `src/` 目录 2. **创建客户配置**: 在 `clients/` 目录下创建客户文件夹，添加配置文件 3. **配置元数据**: 修改 `metadata.yaml` 设置客户信息 ### Step 4: 下载生成的文档 生成的文档保存在 `build/` 目录，可通过 Web 界面直接下载。 --- ## 目录结构 ``` /app/ ├── src/ # 文档源文件 (Markdown) │ ├── metadata.yaml # 全局元数据 │ ├── images/ # 图片资源 │ ├── 01-概述.md │ ├── 02-系统架构.md │ └── ... ├── clients/ # 客户配置 │ ├── default/ # 默认配置 │ └── 标准文档/ # 自定义客户 │ ├── metadata.yaml # 客户元数据 (覆盖全局) │ ├── 运维手册.yaml # 文档类型配置 │ └── ... ├── templates/ # Word 模板 │ └── default.docx └── build/ # 输出目录 --- ## 文件夹详细说明 ### 📁 `src/` - 文档源文件目录 存放所有 Markdown 格式的文档模块。 **文件要求：** - 文件格式：`.md` (Markdown) - 命名规范：使用 `01-`、`02-` 等数字前缀控制排序 - 编码：UTF-8 - 图片引用：使用相对路径 `images/xxx.png` **目录结构：** ``` src/ ├── metadata.yaml # [必需] 全局元数据 (标题、作者、版本等) ├── images/ # [可选] 图片资源目录 │ └── logo.png ├── 01-概述.md # 文档模块 ├── 02-系统架构.md ├── 03-日常运维.md └── ... ``` **metadata.yaml 示例：** ```yaml --- title: "XX系统运维手册" author: "运维团队" date: "2026年1月" version: "v1.0" --- ``` --- ### 📁 `clients/` - 客户配置目录 为不同客户/项目定义文档组合和元数据覆盖。 **目录结构：** ``` clients/ ├── 标准文档/ # 客户名称 (显示在 Web 界面) │ ├── metadata.yaml # [可选] 客户元数据覆盖 │ ├── 运维手册.yaml # 文档类型配置 │ ├── 部署手册.yaml │ └── PDF示例.yaml └── 其他客户/ └── ... ``` **文档类型配置文件示例 (`运维手册.yaml`)：** ```yaml client_name: "标准文档" template: "default.docx" # 选择要包含的文档模块 modules: - src/metadata.yaml - src/01-概述.md - src/02-系统架构.md - src/03-日常运维.md # 输出文件名模式 output_pattern: "{client}_{title}_{date}.docx" # PDF 输出选项 (可选) pdf_options: mainfont: "Noto Sans CJK SC" CJKmainfont: "Noto Sans CJK SC" monofont: "DejaVu Sans Mono" titlepage: true titlepage-color: "2C3E50" toc: true toc-depth: 3 ``` **客户元数据覆盖 (`metadata.yaml`)：** ```yaml --- title: "XX系统运维手册" subtitle: "客户定制版" client: name: "某某公司" contact: "张工" --- ``` --- ### 📁 `templates/` - Word 模板目录 存放 Word 文档模板 (`.docx` 格式)。 **文件要求：** - 格式：`.docx` (Word 2007+) - 建议：使用 Pandoc 兼容的模板样式 **使用方法：** 1. 将自定义模板放入此目录 2. 在客户配置中引用：`template: "custom.docx"` --- ### 📁 `build/` - 输出目录 生成的文档保存位置，支持通过 Web 界面下载。 **说明：** - 生成的 Word 文件：`{客户名}_{文档类型}_{日期}.docx` - 生成的 PDF 文件：`{客户名}_{文档类型}_{日期}.pdf` - 建议挂载到持久化存储