Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Documentation

This directory contains comprehensive documentation for the MarkItDown MCP server.

📁 Documentation Structure

/api/

API documentation and technical specifications

  • Tool schemas and parameters
  • MCP protocol implementation details
  • Response formats and error codes

/development/

Development and contribution documentation

/guides/

User guides and troubleshooting

  • KNOWN_ISSUES.md - Known issues and workarounds
  • Installation guides
  • Configuration tutorials

📖 Quick Links

For Users

For Developers

For API Consumers

🔄 Documentation Updates

This documentation is maintained alongside the codebase. When making changes:

  1. Update relevant documentation files
  2. Add new guides for significant features
  3. Update the changelog for documentation changes
  4. Ensure examples remain current with code changes

📋 Documentation Standards

  • Use clear, concise language
  • Include practical examples
  • Keep guides up-to-date with latest features
  • Follow Markdown best practices
  • Include troubleshooting sections where appropriate