docx2md

DOCX to Markdown Converter

This project provides a utility to convert .docx files to Markdown format.

Prerequisites

• Python 3.6 or later
• pip (Python package installer)

Setup Instructions

1. Clone the Repository

git clone https://github.com/CirrusLabs-NPD/docx2md.git

cd docx2md

2. Set Up Virtual Environment

Create a virtual environment to manage dependencies.

python -m venv venv

3. Activate the virtual environment:

On Windows:

venv\Scripts\activate

On macOS and Linux:

source venv/bin/activate

4. Install Required Packages

Install the necessary Python packages using pip:

pip install python-docx markdown pillow requests

5. Directory Structure

Ensure your directory structure looks like this:

docx2md/
│
├── images/
│
├── app.py
│
└── utils.py

6. Run the python App

Start the doc2md app:

python app.py          

7. Using the App

• Upload a .docx file using the file uploader. View the converted Markdown content and download the Markdown file.
• View any extracted images from the .docx file.

8. Project Files:

• app.py: Contains the Streamlit app code.
• utils.py: Contains utility functions for converting .docx to Markdown and reading Markdown files.