Skip to content

A container version of markitdown , projected to be used on os that you don't have the write versions or tools

License

Notifications You must be signed in to change notification settings

OUIsolutions/Contanizer-Markitdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Contanizer Markitdown

A containerized version of Microsoft's markitdown tool that converts various file formats (PDF, Word, PowerPoint, etc.) to Markdown format using Docker or Podman containers.

Features

  • 🚀 Easy containerized deployment - No complex Python environment setup required
  • 📄 Multiple format support - Convert PDF, DOCX, PPTX, and more to Markdown
  • 🐳 Container-based - Uses Docker or Podman for isolated execution
  • 🛠️ Simple CLI - Straightforward command-line interface

Prerequisites

Before installing Contanizer Markitdown, you'll need one of the following container runtimes:

Installation

Step 1: Install VibeScript

VibeScript is required to run Contanizer Markitdown. Choose the installation method for your operating system:

For Linux Users (Recommended)

Option A: Pre-compiled Binary

curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.36.0/vibescript.out -o vibescript.out
chmod +x vibescript.out
sudo mv vibescript.out /usr/local/bin/vibescript

Option B: Compile from Source

curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.36.0/amalgamation.c -o vibescript.c
gcc vibescript.c -o vibescript.out
sudo mv vibescript.out /usr/local/bin/vibescript

For macOS Users

curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.36.0/amalgamation.c -o vibescript.c
gcc vibescript.c -o vibescript.out
sudo mv vibescript.out /usr/local/bin/vibescript

Note: Make sure you have GCC installed. You can install it via Xcode Command Line Tools: xcode-select --install

Step 2: Install Contanizer Markitdown

Once VibeScript is installed, add the markitdown script:

vibescript add_script --file https://github.com/OUIsolutions/Contanizer-Markitdown/releases/download/0.1.0/markitdown.lua markitdown

Step 3: Configure Container Provider

Choose your preferred container runtime:

For Docker users:

markitdown set_provider docker

For Podman users:

markitdown set_provider podman

Usage

Basic Usage

Convert any supported file to Markdown:

markitdown your-file.pdf > output.md

Examples

Convert a PDF document:

markitdown document.pdf > document.md

Convert a Word document:

markitdown presentation.docx > presentation.md

Convert a PowerPoint presentation:

markitdown slides.pptx > slides.md

Supported File Formats

Contanizer Markitdown supports the same file formats as the original markitdown tool, including:

  • PDF (.pdf)
  • Microsoft Word (.docx, .doc)
  • Microsoft PowerPoint (.pptx, .ppt)
  • Microsoft Excel (.xlsx, .xls)
  • Images with OCR support
  • And more...

Troubleshooting

Common Issues

  1. "Provider not set" error: Make sure you've configured your container provider using markitdown set_provider <docker|podman>

  2. Permission denied: Ensure Docker/Podman is running and your user has the necessary permissions

  3. Command not found: Verify that VibeScript is properly installed and in your PATH

Getting Help

If you encounter issues, please check the Issues page or create a new issue with details about your problem.

Contributing

We welcome contributions! Please feel free to submit a Pull Request.

License

This project is licensed under the same terms as the original markitdown project. See the LICENSE file for details.

Acknowledgments

About

A container version of markitdown , projected to be used on os that you don't have the write versions or tools

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages