WhatsUpDoc logo

WhatsUpDoc

by paradiselabs-ai

WhatsUpDoc is a command-line tool for fetching and storing developer documentation locally. It uses the Model Context Protocol (MCP) for standardized communication.

View on GitHub

Last updated: N/A

What is WhatsUpDoc?

WhatsUpDoc (downmarked) is a command-line tool designed to fetch developer documentation from websites and store it locally in Markdown format. It leverages the Model Context Protocol (MCP) to ensure standardized communication.

How to use WhatsUpDoc?

To use WhatsUpDoc, install it globally using npm install -g downmarked or use it with npx. Use the downmarked fetch <url> command to fetch documentation. Options like -o for output path, -s for CSS selector, -r for recursive fetching, -d for max depth, and --split for splitting by headers are available.

Key features of WhatsUpDoc

  • Fetch documentation from any website and convert it to Markdown

  • Save documentation to any location on your system

  • Target specific content using CSS selectors

  • Recursively fetch linked documentation pages

  • Split documentation by headers into separate files

  • Uses the Model Context Protocol (MCP) for standardized communication

Use cases of WhatsUpDoc

  • Creating local copies of API documentation for offline access

  • Archiving documentation for long-term preservation

  • Extracting specific sections of documentation for focused study

  • Converting documentation into a consistent Markdown format for integration with other tools

FAQ from WhatsUpDoc

What is the Model Context Protocol (MCP)?

MCP is a communication framework used by WhatsUpDoc to standardize communication between the CLI and the documentation server.

What is Cheerio used for?

Cheerio is used for parsing the HTML content fetched from the specified URL.

What is Turndown used for?

Turndown is used for converting the parsed HTML content into Markdown format.

How do I contribute to WhatsUpDoc?

You are welcome to contribute by forking the repository, creating a feature branch, committing your changes, pushing to the remote branch, and opening a pull request.

What license is WhatsUpDoc released under?

WhatsUpDoc is released under the MIT License.