Replaced placeholder content in the readme.
This commit is contained in:
27
README.md
27
README.md
@@ -1,14 +1,27 @@
|
|||||||
# MarkItDown
|
# MarkItDown
|
||||||
|
|
||||||
> This repo has been populated by an initial template to help get you started. Please
|
The MarkItDown library is a utility tool for converting various files to Markdown (e.g., for indexing, text analysis, etc.)
|
||||||
> make sure to update the content to build a great experience for community-building.
|
|
||||||
|
|
||||||
As the maintainer of this project, please make a few updates:
|
It presently supports:
|
||||||
|
|
||||||
- Improving this README.MD file to provide a great experience
|
- PDF (.pdf)
|
||||||
- Updating SUPPORT.MD with content about this project's support experience
|
- PowerPoint (.pptx)
|
||||||
- Understanding the security reporting process in SECURITY.MD
|
- Word (.docx)
|
||||||
- Remove this section from the README
|
- Excel (.xlsx)
|
||||||
|
- Images (EXIF metadata, and OCR)
|
||||||
|
- Audio (EXIF metadata, and speech transcription)
|
||||||
|
- HTML (special handling of Wikipedia, etc.)
|
||||||
|
- Various other text-based formats (csv, json, xml, etc.)
|
||||||
|
|
||||||
|
The API is simple:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from markitdown import MarkItDown
|
||||||
|
|
||||||
|
markitdown = MarkItDown()
|
||||||
|
result = markitdown.convert("test.xlsx")
|
||||||
|
print(result.text_content)
|
||||||
|
```
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user