Whatsupdoc

🚀 WhatsUpDoc

WhatsUpDoc 是一款強大的命令行工具，藉助模型上下文協議（MCP），它能夠從任意網站抓取開發者文檔，並將其本地存儲。這極大地方便了開發者獲取和管理所需的文檔資源。

🚀 快速開始

使用 WhatsUpDoc 可以輕鬆地從網站獲取文檔並保存為 Markdown 格式。以下是基本的使用步驟：

downmarked fetch <url>

運行上述命令後，你將被提示輸入輸出位置，之後文檔會以 Markdown 格式保存。

✨ 主要特性

• 🌐 從任何網站獲取文檔，並將其轉換為 Markdown 格式，方便本地查看和編輯。
• 💾 可將文檔保存到系統上的任意位置，滿足不同的存儲需求。
• 🎯 支持使用 CSS 選擇器指定特定內容，精準獲取所需信息。
• 🔗 能夠遞歸獲取鏈接的文檔頁面，確保獲取完整的文檔體系。
• 📄 根據標題將文檔拆分到單獨文件中，便於組織和管理。
• 🛠️ 使用模型上下文協議（MCP）實現標準化通信，保證數據交互的穩定性。

📦 安裝指南

全局安裝

# 全局安裝
npm install -g downmarked

使用 npx

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

💻 使用示例

基礎用法

downmarked fetch <url>

此命令會提示你輸入輸出位置，並將文檔保存為 Markdown 格式。

高級用法

# 帶有特定選項獲取文檔
downmarked fetch https://reactjs.org/docs/getting-started.html \
  -o ~/Documents/react-docs.md \
  -s "main" \
  -r \
  -d 2 \
  --split

可用選項

具體示例

獲取 React 文檔

# 將React文檔保存到特定位置
downmarked fetch https://reactjs.org/docs/getting-started.html -o ~/Documents/react-docs.md

# 只獲取主要內容區域
downmarked fetch https://reactjs.org/docs/getting-started.html -s "main"

# 遞歸獲取鏈接頁面，深度最多2層
downmarked fetch https://reactjs.org/docs/getting-started.html -r -d 2

獲取 Python 文檔

# 保存Python文檔
downmarked fetch https://docs.python.org/3/tutorial/index.html -o python-tutorial.md

🔧 技術細節

WhatsUpDoc 使用模型上下文協議（MCP）實現標準化通信。其工作流程如下：

1. 從指定 URL 獲取 HTML 內容。
2. 使用 Cheerio 解析 HTML，提取所需信息。
3. 使用 Turndown 將 HTML 轉換為 Markdown 格式。
4. 將 Markdown 保存到指定位置。

🤝 貢獻

歡迎大家為 WhatsUpDoc 項目貢獻力量！如果你有新的想法或改進建議，請按照以下步驟提交 Pull Request：

1. 叉克倉庫。
2. 創建功能分支（git checkout -b feature/amazing-feature）。
3. 提交更改（git commit -m '添加一些 amazing 功能'）。
4. 推送到分支（git push origin feature/amazing-feature）。
5. 打開 Pull Request。

📄 許可證

本項目使用 MIT 許可證，詳情請參閱 LICENSE 文件。

🙏 致謝

感謝以下項目對 WhatsUpDoc 的貢獻：

• 模型上下文協議（MCP） 提供通信框架。
• Turndown 實現 HTML 到 Markdown 轉換。
• Cheerio 用於 HTML 解析。