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

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

Docs: Add technical reference and update README #1509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef07a2e
Add technical reference documentation and update README
YasirAlibrahem Dec 17, 2025
b3cfb13
remove duplicate text from README
YasirAlibrahem Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ cd markitdown
pip install -e 'packages/markitdown[all]'
```

> [!NOTE]
> On some shells (like zsh), you must quote the package name (e.g. `'markitdown[all]'`) to prevent the shell from interpreting the square brackets as a glob pattern.

## Usage

### Command-Line
Expand Down Expand Up @@ -183,6 +186,9 @@ docker build -t markitdown:latest .
docker run --rm -i markitdown:latest < ~/your-file.pdf > output.md
```

## Technical Documentation
For detailed information about the technical implementation, architecture, and advanced usage of MarkItDown, please refer to the

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down
Loading