Whatsupdoc

🚀 WhatsUpDoc

A command-line tool that uses the Model Context Protocol (MCP) to fetch and locally store developer documentation from any website.

✨ Features

• Fetch documentation from any website and convert it to Markdown format.
• Save the documentation to any location on the system.
• Use CSS selectors to specify specific content.
• Recursively fetch linked documentation pages.
• Split the documentation into separate files based on headings.
• Implement standardized communication using the Model Context Protocol (MCP).

📦 Installation

# Install globally
npm install -g downmarked

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

💻 Usage Examples

Basic Usage

downmarked fetch <url>

This will prompt you to enter the output location and save the documentation as Markdown.

Options

# 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

Available Options

Examples

Fetch React Documentation

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

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

# Recursively fetch linked pages with a maximum depth of 2
downmarked fetch https://reactjs.org/docs/getting-started.html -r -d 2

Fetch Python Documentation

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

🔧 Technical Details

WhatsUpDoc uses the Model Context Protocol (MCP) for standardized communication. The tool:

1. Fetches HTML content from the specified URL.
2. Parses the HTML using Cheerio.
3. Converts the HTML to Markdown using Turndown.
4. Saves the Markdown to the specified location.

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgments

Thanks to the following projects for their contributions:

• Model Context Protocol (MCP) for providing the communication framework.
• Turndown for HTML to Markdown conversion.
• Cheerio for HTML parsing.