Skip to content

Python tool for converting files and office documents to Markdown.

Merge branch 'main' into main

gagbae4669107c62
diff --cc README.md
index 3eac77bc,f0f2e83c..6c72d0d3
--- a/README.md
+++ b/README.md
@@@ -39,7 -41,26 +41,26 @@@ 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.
+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
from markitdown import MarkItDown