Skip to content

Commit

Permalink
docs: update README with Docker instructions and details
Browse files Browse the repository at this point in the history
Enhance the README by adding detailed Docker usage instructions, 
including build, version check, and conversion commands for both 
Windows and Linux. This improves accessibility for users who 
prefer using Docker for the project.
  • Loading branch information
l-lumin authored and gitbutler-client committed Dec 20, 2024
1 parent 18e3f1d commit 28f440e
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,41 @@ result = md.convert("example.jpg")
print(result.text_content)
```

### Docker
<details>
<summary>Docker</summary>

#### Build

```sh
docker build -t markitdown:latest .
docker run --rm -i markitdown:latest < ~/your-file.pdf > output.md
```

#### Check version

```sh
docker run --rm markitdown:latest --version
```

#### Convert

- On Windows (PowerShell):

```sh
docker run --rm --volume ${pwd}:/src --workdir /src markitdown:latest ./path-to-your-file.pdf
```

- On Linux:

```sh
docker run --rm --volume $(pwd):/src --workdir /src markitdown:latest ./path-to-your-file.pdf
```

Note: When specifying the file path, always use `/` as the separator, even on Windows (e.g., ./my-folder/my-file.pdf).

</details>

<details>

<summary>Batch Processing Multiple Files</summary>

This example shows how to convert multiple files to markdown format in a single run. The script processes all supported files in a directory and creates corresponding markdown files.
Expand All @@ -87,7 +114,7 @@ for file in files_to_convert:
result = md.convert(file)
with open(md_file, 'w') as f:
f.write(result.text_content)

print(f"Successfully converted {file} to {md_file}")
except Exception as e:
print(f"Error converting {file}: {str(e)}")
Expand All @@ -101,7 +128,7 @@ print("\nAll conversions completed!")
Note that original files will remain unchanged and new markdown files are created with the same base name.

</details>

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down

0 comments on commit 28f440e

Please sign in to comment.