Skip to content

docs: Use double quotes for pip extras so install commands work in cmd.exe #2242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LHMQ878 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −6
Open

docs: Use double quotes for pip extras so install commands work in cmd.exe #2242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ conda activate markitdown

## Installation

To install MarkItDown, use pip: `pip install 'markitdown[all]'`. Alternatively, you can install it from the source:
To install MarkItDown, use pip: `pip install "markitdown[all]"`. Alternatively, you can install it from the source:

```bash
git clone git@github.com:microsoft/markitdown.git
cd markitdown
pip install -e 'packages/markitdown[all]'
pip install -e "packages/markitdown[all]"
```

## Usage
Expand All @@ -92,7 +92,7 @@ cat path-to-file.pdf | markitdown
MarkItDown has optional dependencies for activating various file formats. Earlier in this document, we installed all optional dependencies with the `[all]` option. However, you can also install them individually for more control. For example:

```bash
pip install 'markitdown[pdf, docx, pptx]'
pip install "markitdown[pdf, docx, pptx]"
```

will install only the dependencies for PDF, DOCX, and PPTX files.
Expand Down Expand Up @@ -163,7 +163,7 @@ See [`packages/markitdown-ocr/README.md`](packages/markitdown-ocr/README.md) for

[Azure Content Understanding](https://learn.microsoft.com/azure/ai-services/content-understanding/) provides higher-quality conversion with structured field extraction (YAML front matter), multi-modal support (documents, images, audio, video), and configurable analyzers.

Install: `pip install 'markitdown[az-content-understanding]'`
Install: `pip install "markitdown[az-content-understanding]"`

#### When to use Content Understanding

Expand Down
4 changes: 2 additions & 2 deletions packages/markitdown/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
From PyPI:

```bash
pip install 'markitdown[all]'
pip install "markitdown[all]"
```

From source:

```bash
git clone git@github.com:microsoft/markitdown.git
cd markitdown
pip install -e 'packages/markitdown[all]'
pip install -e "packages/markitdown[all]"
```

## Usage
Expand Down