docs: update README with Docker instructions and details

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.
This commit is contained in:
lumin 2024-12-20 23:58:14 +09:00 committed by GitButler
parent f94d09990e
commit 9c4a542193

View file

@ -66,14 +66,41 @@ result = md.convert("example.jpg")
print(result.text_content) print(result.text_content)
``` ```
### Docker <details>
<summary>Docker</summary>
#### Build
```sh ```sh
docker build -t markitdown:latest . 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> <details>
<summary>Batch Processing Multiple Files</summary> <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. 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.
@ -94,7 +121,7 @@ for file in files_to_convert:
result = md.convert(file) result = md.convert(file)
with open(md_file, 'w') as f: with open(md_file, 'w') as f:
f.write(result.text_content) f.write(result.text_content)
print(f"Successfully converted {file} to {md_file}") print(f"Successfully converted {file} to {md_file}")
except Exception as e: except Exception as e:
print(f"Error converting {file}: {str(e)}") print(f"Error converting {file}: {str(e)}")
@ -108,7 +135,7 @@ print("\nAll conversions completed!")
Note that original files will remain unchanged and new markdown files are created with the same base name. Note that original files will remain unchanged and new markdown files are created with the same base name.
</details> </details>
## Contributing ## 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