WhatsUpDoc (downmarked)

WhatsUpDoc (downmarked)

site icon
2025.04.09 2
JavaScript文档管理开发工具开发效率
WhatsUpDoc(downmarked)是一个命令行工具,用于通过模型上下文协议(MCP)获取和本地存储开发者文档。它能够从任何网站获取文档并将其转换为Markdown格式,支持递归获取链接的文档页面,并按标题分割成单独的文件。
View on GitHub

Overview

基本能力

产品定位

WhatsUpDoc(downmarked)是一个专注于开发者文档管理的命令行工具,旨在帮助开发者高效获取、转换和存储文档。

核心功能

  • 从任何网站获取文档并转换为Markdown格式
  • 将文档保存到系统的任意位置
  • 使用CSS选择器定位特定内容
  • 递归获取链接的文档页面
  • 按标题将文档分割成单独的文件
  • 使用模型上下文协议(MCP)进行标准化通信

适用场景

  • 开发者需要离线访问文档
  • 需要将HTML文档转换为Markdown格式
  • 需要递归获取并存储多个链接的文档页面
  • 需要按标题分割文档以便于管理

工具列表

  • Turndown:用于HTML到Markdown的转换
  • Cheerio:用于HTML解析

常见问题解答

  • 如何安装WhatsUpDoc? 使用npm全局安装或通过npx直接运行。
  • 如何指定输出路径? 使用-o--output选项指定输出路径。
  • 如何递归获取文档? 使用-r--recursive选项启用递归获取。

使用教程

使用依赖

WhatsUpDoc依赖于Node.js和npm。确保已安装Node.js和npm。

安装教程

# 全局安装
npm install -g downmarked

# 或使用npx
npx downmarked fetch https://reactjs.org/docs/getting-started.html

调试方式

安装完成后,可以通过以下命令测试工具是否正常工作:

downmarked fetch https://reactjs.org/docs/getting-started.html -o ~/Documents/react-docs.md

检查输出文件是否包含预期的Markdown内容。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。