Skip to content

Commit

Permalink
Merge pull request #11 from simonw/patch-2
Browse files Browse the repository at this point in the history
CLI usage instructions
  • Loading branch information
gagb authored Dec 16, 2024
2 parents 81e3f24 + e7d9b55 commit c9c7d98
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MarkItDown

[![PyPI](https://img.shields.io/pypi/v/markitdown.svg)](https://pypi.org/project/markitdown/)

The MarkItDown library is a utility tool for converting various files to Markdown (e.g., for indexing, text analysis, etc.)

It presently supports:
Expand Down Expand Up @@ -27,7 +29,6 @@ or from the source
pip install -e .
```


# Usage
The API is simple:

Expand All @@ -39,6 +40,25 @@ result = markitdown.convert("test.xlsx")
print(result.text_content)
```

To use this as a command-line utility, install it and then run it like this:

```bash
markitdown path-to-file.pdf
```

This will output Markdown to standard output. You can save it like this:

```bash
markitdown path-to-file.pdf > document.md
```

You can pipe content to standard input by omitting the argument:

```bash
cat path-to-file.pdf | markitdown
```


You can also configure markitdown to use Large Language Models to describe images. To do so you must provide mlm_client and mlm_model parameters to MarkItDown object, according to your specific client.

```python
Expand Down

0 comments on commit c9c7d98

Please sign in to comment.