SuperAPI AI 工具集

mdq

写作与研究

查看项目

更新于 10-16 06:14

技能介绍

用途:mdq 用于解析、搜索、grep、查询、过滤或提取 Markdown 文件中的标题、章节、任务、代码块、链接、表格等元素。基本用法为 mdq [OPTIONS] [SELECTORS] [FILE...],未给文件时读取标准输入,多文件会拼接处理。

选择器语法:普通字符串匹配不区分大小写,且须以字母开头,如 installation;带引号的字符串区分大小写,如 "Getting Started";/pattern/ 使用 fancy-regex,如 /getting.started/i;* 或空选择器匹配任意内容;^start 或 end$ 用于位置锚定。

主要能力:可用 # 选择器定位标题,并可链式组合子选择器;用 - [ ]、- [x]、- [?] 提取任务状态;用 选择器配合可选语言过滤提取代码块;配合 --output json 输出结构化数据。示例:mdq '# examples |' guide.md 获取 “Examples” 章节中的代码块;mdq '# release | - [x]' CHANGELOG.md 查找 “Release” 章节中已勾选任务。

使用方式与最佳实践:用 | 链式选择器先缩小范围再提取子元素;在 CI/CD 脚本中使用 --quiet(-q)与退出码而非解析标准输出;将结果管道给 jq 等工具时使用 --output json;跨平台场景用 /pattern/i 进行不区分大小写匹配;纯文本处理管线可用 --output plain。

限制与注意事项:mdq 仅适用于 CommonMark Markdown 文件,不应期望其对 AsciiDoc、RST、HTML 等其他格式产生类似结果,这些格式需使用对应工具。常见问题包括无匹配(--quiet 模式下退出码为 1)、输出格式意外或提取多余内容、选择器误匹配、以及 mdq 命令未安装。

资料未提供安装方式、平台支持、收费与价格等具体信息。