diff --git a/README.md b/README.md index 8ac2fe3..70f188d 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ MarkItDown is a utility for converting various files to Markdown (e.g., for indexing, text analysis, etc). It supports: + - PDF - PowerPoint - Word @@ -18,9 +19,10 @@ It supports: - HTML - Text-based formats (CSV, JSON, XML) - ZIP files (iterates over contents) +- Youtube URLs - ... 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: ```bash git clone git@github.com:microsoft/markitdown.git @@ -74,7 +76,6 @@ markitdown path-to-file.pdf -o document.md -d -e " output.md ``` - + ## Contributing -This project welcomes contributions and suggestions. Most contributions require you to agree to a +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. @@ -134,13 +135,12 @@ 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. -
-| | 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) | -| **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) | +| | 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) | +| **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) |
@@ -148,22 +148,24 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc - Navigate to the MarkItDown package: - ```sh - cd packages/markitdown - ``` + ```sh + cd packages/markitdown + ``` - Install `hatch` in your environment and run tests: - ```sh - pip install hatch # Other ways of installing hatch: https://hatch.pypa.io/dev/install/ - hatch shell - hatch test - ``` + + ```sh + pip install hatch # Other ways of installing hatch: https://hatch.pypa.io/dev/install/ + hatch shell + hatch test + ``` (Alternative) Use the Devcontainer which has all the dependencies installed: - ```sh - # Reopen the project in Devcontainer and run: - hatch test - ``` + + ```sh + # Reopen the project in Devcontainer and run: + hatch test + ``` - Run pre-commit checks before submitting a PR: `pre-commit run --all-files` @@ -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. - ## Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft