Skip to content

Docs: Add technical reference and update README #1509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
YasirAlibrahem wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: Add technical reference and update README #1509

YasirAlibrahem wants to merge 2 commits into from

Conversation

@YasirAlibrahem
Copy link

@YasirAlibrahem YasirAlibrahem commented Dec 17, 2025

Description

This PR introduces a comprehensive technical reference document to help users and contributors understand the internal API and advanced usage of MarkItDown.

Changes

  • Added docs/REFERENCE.md: A detailed reference guide containing:
    • API Documentation: Detailed breakdown of MarkItDown, DocumentConverter, DocumentConverterResult, and other core classes.
    • Converter Reference: List of built-in converters, supported formats, and dependencies.
    • Extension Guides: Step-by-step instructions for creating custom converters and plugins.
    • CLI Reference: Detailed usage options and examples for the command-line interface.
  • Updated README.md:
    • Added a section pointing readers to technical reference document
    • Added a troubleshooting note for zsh users regarding quoting package names (e.g., 'markitdown[all]') during installation.
@YasirAlibrahem
Copy link
Author

YasirAlibrahem commented Dec 17, 2025

@microsoft-github-policy-service agree
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant

@YasirAlibrahem