Merge branch 'main' into fix/18
This commit is contained in:
commit
aeff2cb5ae
1 changed files with 21 additions and 1 deletions
22
README.md
22
README.md
|
|
@ -1,5 +1,7 @@
|
||||||
# MarkItDown
|
# MarkItDown
|
||||||
|
|
||||||
|
[](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.)
|
The MarkItDown library is a utility tool for converting various files to Markdown (e.g., for indexing, text analysis, etc.)
|
||||||
|
|
||||||
It presently supports:
|
It presently supports:
|
||||||
|
|
@ -27,7 +29,6 @@ or from the source
|
||||||
pip install -e .
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
The API is simple:
|
The API is simple:
|
||||||
|
|
||||||
|
|
@ -39,6 +40,25 @@ result = markitdown.convert("test.xlsx")
|
||||||
print(result.text_content)
|
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
|
```python
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue