luciano/markitdown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(readme): add youtube URLs as markitdown supports

Browse source
This commit is contained in:
Nima 2025-02-18 21:17:20 +01:00
parent cc36fe9f0b
commit 0c5c6d092f
1 changed files with 23 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -9,6 +9,7 @@
MarkItDown is a utility for converting various files to Markdown (e.g., for indexing, text analysis, etc). MarkItDown is a utility for converting various files to Markdown (e.g., for indexing, text analysis, etc).
It supports: It supports:
- PDF - PDF
- PowerPoint - PowerPoint
- Word - Word
@ -18,6 +19,7 @@ It supports:
- HTML - HTML
- Text-based formats (CSV, JSON, XML) - Text-based formats (CSV, JSON, XML)
- ZIP files (iterates over contents) - ZIP files (iterates over contents)
- Youtube URLs
- ... and more! - ... and more!
To install MarkItDown, use pip: `pip install markitdown`. Alternatively, you can install it from the source: To install MarkItDown, use pip: `pip install markitdown`. Alternatively, you can install it from the source:
@ -74,7 +76,6 @@ markitdown path-to-file.pdf -o document.md -d -e "<document_intelligence_endpoin
More information about how to set up an Azure Document Intelligence Resource can be found [here](https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/how-to-guides/create-document-intelligence-resource?view=doc-intel-4.0.0) More information about how to set up an Azure Document Intelligence Resource can be found [here](https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/how-to-guides/create-document-intelligence-resource?view=doc-intel-4.0.0)
### Python API ### Python API
Basic usage in Python: Basic usage in Python:
@ -134,11 +135,10 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
You can help by looking at issues or helping review PRs. Any issue or PR is welcome, but we have also marked some as 'open for contribution' and 'open for reviewing' to help facilitate community contributions. These are ofcourse just suggestions and you are welcome to contribute in any way you like. You can help by looking at issues or helping review PRs. Any issue or PR is welcome, but we have also marked some as 'open for contribution' and 'open for reviewing' to help facilitate community contributions. These are ofcourse just suggestions and you are welcome to contribute in any way you like.
<div align="center"> <div align="center">
| | All | Especially Needs Help from Community | | | All | Especially Needs Help from Community |
|-----------------------|------------------------------------------|------------------------------------------------------------------------------------------| | ---------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| **Issues** | [All Issues](https://github.com/microsoft/markitdown/issues) | [Issues open for contribution](https://github.com/microsoft/markitdown/issues?q=is%3Aissue+is%3Aopen+label%3A%22open+for+contribution%22) | | **Issues** | [All Issues](https://github.com/microsoft/markitdown/issues) | [Issues open for contribution](https://github.com/microsoft/markitdown/issues?q=is%3Aissue+is%3Aopen+label%3A%22open+for+contribution%22) |
| **PRs** | [All PRs](https://github.com/microsoft/markitdown/pulls) | [PRs open for reviewing](https://github.com/microsoft/markitdown/pulls?q=is%3Apr+is%3Aopen+label%3A%22open+for+reviewing%22) | | **PRs** | [All PRs](https://github.com/microsoft/markitdown/pulls) | [PRs open for reviewing](https://github.com/microsoft/markitdown/pulls?q=is%3Apr+is%3Aopen+label%3A%22open+for+reviewing%22) |
@ -153,6 +153,7 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc
``` ```
- Install `hatch` in your environment and run tests: - Install `hatch` in your environment and run tests:
```sh ```sh
pip install hatch # Other ways of installing hatch: https://hatch.pypa.io/dev/install/ pip install hatch # Other ways of installing hatch: https://hatch.pypa.io/dev/install/
hatch shell hatch shell
@ -160,6 +161,7 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc
``` ```
(Alternative) Use the Devcontainer which has all the dependencies installed: (Alternative) Use the Devcontainer which has all the dependencies installed:
```sh ```sh
# Reopen the project in Devcontainer and run: # Reopen the project in Devcontainer and run:
hatch test hatch test
@ -171,7 +173,6 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc
You can also contribute by creating and sharing 3rd party plugins. See `packages/markitdown-sample-plugin` for more details. You can also contribute by creating and sharing 3rd party plugins. See `packages/markitdown-sample-plugin` for more details.
## Trademarks ## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft