Running Tests & Checks

How to run MarkItDown's test suite and pre-commit checks locally, with hatch, or inside a Devcontainer.

cd packages/markitdown

pip install hatch  # Other ways of installing hatch: https://hatch.pypa.io/dev/install/
hatch shell
hatch test

Run these before submitting a PR:

pre-commit run --all-files

Alternative: Devcontainer

Use the Devcontainer which has all the dependencies installed:

# Reopen the project in Devcontainer and run:
hatch test

Extending Without Changing This Repo

Extend MarkItDown without changing the core repository by publishing your own 3rd-party conversion plugin.

Security Considerations

Security considerations for MarkItDown: sanitizing untrusted input and choosing the narrowest conversion API for your use case.