Docx2MD Converter

A powerful VS Code extension that provides bidirectional conversion between DOCX/DOC and Markdown formats with advanced formatting preservation, automatic image extraction, and intelligent table conversion.

✨ Features

🔄 Bidirectional Conversion

• DOCX/DOC to Markdown: Convert Word documents to Markdown
• Markdown to DOCX: Convert Markdown files to DOCX format
• Context Menu Integration: Right-click on .docx, .doc, or .md files
• Command Palette: Access both conversion types from command palette

� Document Processing

• �🖼️ Image Extraction: Automatically extracts and organizes images (DOCX→MD)
• 📝 Formatting Preservation: Maintains bold, italic, underline, and other formatting
• 📊 Smart Table Conversion: Converts tables with intelligent formatting detection
• 🔗 Hyperlink Support: Preserves hyperlinks with proper syntax
• 📋 Table of Contents: Auto-generates TOC from document headings
• 📈 Detailed Reports: Comprehensive conversion reports with statistics

🎯 User Experience

• Universal Format Support: DOCX, DOC, and Markdown files
• Configurable Output: Customizable output directories and behavior
• Progress Tracking: Real-time conversion progress updates
• Error Handling: Comprehensive error handling and user feedback
• 🐍 Python Backend: Uses robust Python scripts for reliable conversion

🔧 Requirements

System Requirements

• VS Code: Version 1.74.0 or higher
• Python: Version 3.6 or higher (uses standard library only)
• Operating System: Windows, macOS, or Linux

Python Compatibility Matrix

No external Python packages required - uses only standard library modules for maximum compatibility.

📦 Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Docx2MD Converter"
4. Click Install

Manual Installation

1. Download the .vsix file from releases
2. Open VS Code
3. Run Extensions: Install from VSIX... command
4. Select the downloaded file

Python Setup

Ensure Python 3.6+ is installed and accessible:

python --version    # Should show 3.6 or higher
# or
python3 --version   # Alternative command

🚀 Usage

DOCX/DOC to Markdown Conversion

Method 1: Context Menu (Recommended)

1. Right-click any .docx or .doc file in VS Code Explorer
2. Select "Convert DOCX/DOC to Markdown"
3. Conversion starts automatically

Method 2: Command Palette

1. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
2. Type "Convert DOCX/DOC to Markdown"
3. Select the command and choose your file

Markdown to DOCX Conversion

Method 1: Context Menu (Recommended)

1. Right-click any .md file in VS Code Explorer
2. Select "Convert Markdown to DOCX"
3. Conversion starts automatically

Method 2: Command Palette

1. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
2. Type "Convert Markdown to DOCX"
3. Select the command and choose your file

📁 Output Structure

DOCX/DOC to Markdown

The extension creates a well-organized output structure:

TargetMDDirectory/
└── document-name/
    ├── document-name.md          # Main markdown file
    ├── images/                   # Extracted images folder
    │   ├── image_001_spd2m_chart.png
    │   ├── image_002_spd2m_diagram.jpg
    │   └── ...
    └── conversion_report.md      # Detailed conversion report

Markdown to DOCX

Creates a DOCX file next to the original markdown file:

project-folder/
├── document.md                   # Original markdown file
├── document.docx                 # Generated DOCX file
└── document_conversion_report.md # Conversion report

⚙️ Configuration

Configure the extension through VS Code settings (Ctrl+,):

{
    "docx2mdconverter.pythonPath": "python",
    "docx2mdconverter.outputDirectory": "TargetMDDirectory",
    "docx2mdconverter.showReport": true,
    "docx2mdconverter.autoOpenResult": true
}

Available Settings

📊 Supported Features

🔍 Advanced Features

Smart Table Detection

The converter intelligently detects and formats different table types:

• Two-column layouts: Key-value pairs, image-text combinations
• Multi-category tables: Complex data structures with categories
• Standard tables: Traditional markdown table format

Image Management

• Automatic extraction: All embedded images extracted to images/ folder
• Intelligent naming: Sequential numbering with descriptive names
• Format preservation: Maintains original image formats (PNG, JPG, etc.)
• Markdown integration: Proper markdown image syntax with relative paths

Document Structure Analysis

• Heading detection: Multiple methods for identifying headings
• TOC generation: Automatic table of contents with anchor links
• Style preservation: Bold, italic, underline formatting maintained
• List handling: Proper markdown list formatting

🐛 Troubleshooting

Common Issues

Python Not Found

❌ Python not found or not accessible

Solutions:

• Install Python 3.6+ from python.org
• Add Python to system PATH
• Configure docx2mdconverter.pythonPath setting

Script Not Found

❌ Python converter script not found

Solutions:

• Extension will offer to install the script automatically
• Manually place docx_to_markdown_converter.py in workspace
• Use "Locate Script" option from error dialog

Permission Denied

❌ Permission denied

Solutions:

• Check file permissions
• Ensure the document isn't open in another application
• Run VS Code as administrator (Windows)

Conversion Timeout

❌ Conversion timed out

Solutions:

• Try with smaller/simpler documents first
• Close other applications to free memory
• Check if document is corrupted

Debugging Steps

1. Check Output Panel: View detailed logs in "Docx2MD Converter" output channel
2. Verify Python: Run python --version in terminal
3. Test Script: Manually run the Python script from command line
4. Check File: Ensure document isn't password-protected or corrupted

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Setup

1. Clone the repository
2. Run npm install
3. Open in VS Code
4. Press F5 to launch extension host

Reporting Issues

Please include:

• VS Code version
• Python version
• Error messages from output panel
• Sample document (if possible)

📄 License

MIT License - see LICENSE file for details.

🎯 Roadmap

• [ ] Batch conversion support
• [ ] Custom styling options
• [ ] Export to multiple formats
• [ ] Cloud storage integration
• [ ] Real-time preview
• [ ] Enhanced DOC support

📞 Support

• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📧 Email: your-email@example.com

🙏 Acknowledgments

• Python community for excellent standard library
• VS Code team for the extension API
• Contributors and users for feedback and improvements

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!