Repolode
提交项目
bwplotka

bwplotka/mdox

一个 Go 语言 CLI 工具，用于按 GFM 规范格式化 Markdown、从命令输出自动生成代码块、检查链接，并把 Markdown 转换为静态文档网站。

在 GitHub 查看
Star
84
Fork
12
未关闭 Issue
33
最近提交
4天前

这是什么？

mdox 是一个命令行工具，用于让项目文档保持准确和统一。它会按照 GitHub Flavored Markdown 规范就地格式化 Markdown 文件，并检查相对链接和远程链接，可以跳过指定地址，也能通过 GitHub API 校验 issue 和 pull request 链接。

它的代码生成功能通过 mdox-exec 指令标记代码块，运行指定命令并将输出写入代码块，使 CLI 帮助信息、示例配置或源码片段与实际代码保持同步，还可以声明命令预期的退出码。

在网站场景下，mdox 可以把链接改写为相对路径，适配多域名或多版本站点；也支持添加 front matter 和 back matter、重命名或移动文件，并为 Hugo 等静态站点生成器调整链接。项目同时可作为 Go 库使用。

核心功能

  • 01就地将 Markdown 文件格式化为统一的 GFM 风格。
  • 02通过运行命令自动生成代码块内容，例如 CLI 帮助输出。
  • 03检查相对链接和远程链接，支持可配置的跳过规则和 GitHub 链接校验。
  • 04将链接改写为相对路径，适用于多域名或多版本网站。
  • 05为 Hugo 等静态站点生成器添加 front matter 和 back matter，并调整文件位置。

适用场景

  • 通过 CI 让仓库 README 中的 CLI 帮助和配置示例保持最新。
  • 在 pull request 检查中发现文档里失效的链接。
  • 把 Markdown 源文件发布为带版本的静态文档网站。

快速上手

  1. 1

    使用 Go 安装 mdox 命令行工具

  2. 2

    使用 mdox fmt 格式化 Markdown 文件

    mdox fmt *.md

使用前须知

  • README 中没有明确的 go install 命令，因此安装步骤未给出可执行命令。
  • 项目规模较小（80 星），社区支持可能有限。

收录于专题

命令行与终端工具静态网站生成器与文档工具

标签

#markdown#documentation#cli#link-checker#static-site#golang#code-generation

常见问题

mdox 是什么？
一个 Go 语言 CLI 工具，用于按 GFM 规范格式化 Markdown、从命令输出自动生成代码块、检查链接，并把 Markdown 转换为静态文档网站。 mdox 是一个命令行工具，用于让项目文档保持准确和统一。它会按照 GitHub Flavored Markdown 规范就地格式化 Markdown 文件，并检查相对链接和远程链接，可以跳过指定地址，也能通过 GitHub API 校验 issue 和 pull request 链接。
mdox 可以免费使用吗？用的什么许可证？
mdox 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。
mdox 还在维护吗？
活跃维护中。mdox 最近一次提交是在 2026年11月3日。
mdox 适合用来做什么？
通过 CI 让仓库 README 中的 CLI 帮助和配置示例保持最新。 在 pull request 检查中发现文档里失效的链接。 把 Markdown 源文件发布为带版本的静态文档网站。
mdox 怎么安装和运行？
使用 Go 安装 mdox 命令行工具 使用 mdox fmt 格式化 Markdown 文件: mdox fmt *.md
在哪里获取 mdox？
源代码和安装说明在 GitHub 上：https://github.com/bwplotka/mdox

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目