要将文档发布为静态站点,请让 AI 代理将它们转换为带有 YAML 前置元数据且图像保存为文件的 Markdown,然后运行你的生成器。GroupDocs.Markdown.Mcp 在本地完成转换,因此 Claude Desktop、Claude Code、Cursor 或 GitHub Copilot 可以为 Hugo、Jekyll、MkDocs 或 Docusaurus 准备 Word、Excel 和电子书内容,而无需将其发送到服务:
将这些文档转换为带有前置元数据、GitHub 风格且图像保存为文件的 Markdown。
带有配置和故障排除的逐步版本请参阅文档:How to publish documents to a static site as Markdown.
静态站点生成器对文档的需求是什么?
三件事:正文的 Markdown、元数据的 YAML 前置元数据,以及相对路径下的图像文件。Hugo、Jekyll、MkDocs 和 Docusaurus 都会读取前置元数据。当你为 convert_to_markdown 选择相应选项时,它会生成这三项:
| 选项 | 站点的取值 | 作用 |
|---|---|---|
frontMatter |
true |
在文件顶部写入包含标题、作者、格式和页数的 YAML |
images |
"file" |
将图片写在 .md 文件旁边,并通过相对路径引用它们 |
flavor |
"github"(默认)或 "commonmark" |
GitHub 风格的 Markdown 是大多数生成器的默认假设;CommonMark 适用于更严格的工具链 |
检查每个转换后文件顶部的标题和作者;如果为空或不正确,请让代理进行设置。
如何将 Word 转换为 Hugo Markdown?
Hugo 是本博客背后的生成器,因此这里以它为例。整个流程包含四个步骤,代理会执行全部步骤。
- 转换。 对文档文件夹运行上述提示。
- 整理。 服务器写入文件;布局由代理负责。
将每个转换后的文件放入以文档名称命名的文件夹中,其图像放在该文件夹旁的
images子文件夹中。 - 添加主题需要的键。 Hugo 主题通常需要
date或weight。工具不会写入这些键,请这样请求:将
weight添加到每个文件的前置元数据中,按我列出的顺序编号。 - 构建。 自行运行 Hugo。此时文件已是带有前置元数据的普通 Markdown,生成器会像处理其他页面一样处理它们。
对于 Docusaurus 和 MkDocs,输出相同;唯一的区别是文件夹布局和额外的键,需要在第二和第三个提示中说明。
示例会话(摘要)
你: 将 /drafts 中的三个文档转换为带有前置元数据、GitHub 风格且图像保存为文件的 Markdown。每个文档一个文件夹。
代理:convert_to_markdown (frontMatter: true, flavor: "github", images: "file") x 3
创建了 guide-onboarding/、guide-security/、price-list/,其中包含 .md 文件和图像子文件夹。前置元数据包含标题、作者、格式和页数。
你: 按我列出的顺序为每个文件添加 weight。
代理:已为这三个文件的前置元数据更新了 weight,分别为 10、20 和 30。
在发布前如何检查结果?
两项检查几乎可以捕获所有问题:
对每个转换后的文件,将源文件的页数与 Markdown 的长度进行比较。
一个 60 页的文档却只生成了 3 KB 的 Markdown,说明它是扫描的 PDF 或者是评估模式的运行结果。
列出每个文档的图像文件夹以及其 Markdown 引用的图像。
如果 .md 引用了从未写入的图片,站点上会显示破损的图像。在一次性处理两百个文档之前,先抽查最混乱的源文件。
Word 和 Excel 源文件会保持结构完整地转换:标题仍为标题,表格转换为 Markdown 表格。PDF 的转换效果取决于其生成方式。原生数字导出可以干净地转换;扫描件则无法以任何有用的方式转换,因为此服务器没有 OCR 步骤。
前置元数据的哪些键需要我自行添加?
frontMatter: true 会写入标题、作者、格式和页数。检查每个文件中的这些值,并让代理纠正任何为空或错误的项。导航、排序、标签和日期是转换后需要添加的键,如步骤 3 所示。若想将更丰富的文档属性写入前置元数据,可将此服务器与 GroupDocs.Metadata.Mcp 配合使用,它可以读取这些属性,然后让代理添加相应键;本文不涉及此部分。
真实限制
如果没有许可证,服务器会以评估模式运行,仅处理前 3 页,并在每页上添加评估水印。使用未授权输出构建的站点只会得到长文档的三页占位。转换前请运行 get_license_status,并在循环中保持“长度与源文件对比”检查。
常见问题
如何将 Word 转换为 Hugo Markdown?
让代理使用 frontMatter: true、images: "file" 和 flavor: "github" 将文档转换,然后将文件整理到你的 content 文件夹中。随后在第二个提示中添加任何主题特定的键,例如 weight。
AI 代理能将文档发布到静态站点吗?
它可以准备站点构建所需的全部内容:Markdown、前置元数据、图像文件和文件夹布局。你自行运行生成器,构建和部署仍由你掌控。
转换是否在本地进行?
是的。GroupDocs.Markdown.Mcp 作为本地进程通过 stdio 运行,并从你配置的文件夹读取文档。只有在审阅后才公开的文档会一直保留在你的机器上,直至你发布它们。