WhatsUpDoc (downmarked)

WhatsUpDoc (downmarked)

一款命令行工具，可使用模型上下文协议（MCP）获取开发者文档并将其保存到本地。

功能

• 从任意网站获取文档并将其转换为 Markdown
• 将文档保存到系统中的任意位置
• 使用 CSS 选择器定位特定内容
• 递归获取链接的文档页面
• 按标题拆分文档，并保存为单独的文件
• 使用模型上下文协议（MCP）实现标准化通信

安装

# Install globally
npm install -g downmarked

# Or use with npx
npx downmarked fetch https://reactjs.org/docs/getting-started.html

用法

基本用法

downmarked fetch <url>

系统会提示你选择输出位置，并将文档保存为 Markdown。

选项

# Fetch documentation with specific options
downmarked fetch https://reactjs.org/docs/getting-started.html \
  -o ~/Documents/react-docs.md \
  -s "main" \
  -r \
  -d 2 \
  --split

可用选项

选项	描述
-o, --output <path>	输出路径（绝对路径或相对路径）
-s, --selector <selector>	用于定位特定内容的 CSS 选择器
-r, --recursive	递归获取链接的文档页面
-d, --max-depth <number>	递归获取的最大深度（默认值：3）
--split	按标题拆分文档，并保存为单独的文件

示例

获取 React 文档

# Save React documentation to a specific location
downmarked fetch https://reactjs.org/docs/getting-started.html -o ~/Documents/react-docs.md

# Target only the main content area
downmarked fetch https://reactjs.org/docs/getting-started.html -s "main"

# Recursively fetch linked pages up to 2 levels deep
downmarked fetch https://reactjs.org/docs/getting-started.html -r -d 2

获取 Python 文档

# Save Python documentation
downmarked fetch https://docs.python.org/3/tutorial/index.html -o python-tutorial.md

工作原理

WhatsUpDoc (downmarked) 使用模型上下文协议（MCP），规范 CLI 与文档服务之间的通信。该工具会：

1. 从指定 URL 获取 HTML 内容
2. 使用 Cheerio 解析 HTML
3. 使用 Turndown 将 HTML 转换为 Markdown
4. 将 Markdown 保存到指定位置

参与贡献

欢迎贡献！请随时提交 Pull Request。

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 发起 Pull Request

许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

致谢

• Model Context Protocol (MCP) 提供通信框架
• Turndown 用于将 HTML 转换为 Markdown
• Cheerio 用于解析 HTML