Whatsupdoc

🚀 WhatsUpDoc（下線付き）

このコマンドラインツールは、モデルコンテキストプロトコル（MCP）を使用して、任意のウェブサイトから開発者ドキュメントを取得し、ローカルに保存することができます。

🚀 クイックスタート

WhatsUpDocは、モデルコンテキストプロトコル（MCP）を利用したコマンドラインツールで、任意のウェブサイトから開発者ドキュメントを取得し、Markdown形式でローカルに保存できます。

✨ 主な機能

• 任意のウェブサイトからドキュメントを取得し、Markdown形式に変換する
• ドキュメントをシステム上の任意の場所に保存する
• CSSセレクタを使用して特定の内容を指定する
• リンクされたドキュメントページを再帰的に取得する
• タイトルに基づいてドキュメントを個別のファイルに分割する
• モデルコンテキストプロトコル（MCP）を使用して標準化された通信を実現する

📦 インストール

# グローバルインストール
npm install -g downmarked

# または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を指定された場所に保存する

貢献方法

貢献を歓迎します！自由にPull Requestを送信してください。

1. リポジトリをフォークする
2. 機能ブランチを作成する（git checkout -b feature/amazing-feature）
3. 変更をコミットする（git commit -m 'いくつかの素敵な機能を追加'）
4. ブランチにプッシュする（git push origin feature/amazing-feature）
5. Pull Requestを開く

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細はLICENSEファイルを参照してください。

謝辞

以下のプロジェクトの貢献に感謝します。

• モデルコンテキストプロトコル（MCP） 通信フレームワークの提供
• Turndown HTMLからMarkdownへの変換の実現
• Cheerio HTML解析のための利用