SuperAPI AI 工具集

mdq

设计与创作

查看项目

更新于 10-15 16:47

技能介绍

mdq 是一个用于查询 Markdown 文档的命令行工具,工作方式类似 jq 之于 JSON。它通过镜像 Markdown 语法的选择器来筛选内容,默认文本匹配不区分大小写。

主要能力:可提取标题(如 '## ' 取所有二级标题)、有序与无序列表项、任务('- [ ]' 未完成、'- [x]' 已完成、'- [?]' 全部)、链接与图片(按显示文本或 URL 匹配)、引用、代码块(按语言)、HTML 元素、段落、表格(按表头与行内容)以及 YAML/TOML front matter。支持引号区分大小写、^ 与 $ 锚定、/regex/ 正则匹配和 !s/regex/replace/ 替换。用 | 可链式过滤,例如 '# Installation | - ' 取某标题下的列表项。

使用方式:命令格式为 mdq [OPTIONS] <SELECTOR> [FILE],省略 FILE 时从标准输入读取。选项 -q 为静默模式,有匹配则退出码为 0;--output json 输出结构化 JSON,便于配合 jq 处理。安装可用 brew install mdq,或从 GitHub Releases 下载二进制(如 v0.9.0 的 macOS arm64、Linux x64、Linux x64 musl 包),也可用 Docker 镜像 yshavit/mdq。安装后可用 mdq --version 验证。

适用场景:从 README 提取标题或链接、检查 TODO 完成情况、按章节抽取资源链接、筛选特定语言的代码块、从报告表格中取匹配行等。

限制:资料未提供性能、平台兼容性细节、许可协议及错误处理行为等信息。