Markdownify

🚀 Markdownify MCP Server (UTF-8 Version)

This is an enhanced version based on the original Markdownify project, developed to better support UTF-8 encoding.

🚀 Quick Start

Installation Requirements

1. System: Windows, macOS, or Linux
2. Dependencies:
   • Node.js (Recommended version: 16+)
   • Python 3.x

Installation Guide

Step 1: Clone the repository

git clone https://github.com/JDJR2024/markdownify-mcp-utf8.git
cd markdownify-mcp-utf8

Step 2: Install dependencies

npm install
pip install -r requirements.txt

Step 3: Start the server

node dist/index.js

✨ Features

• Comprehensive UTF-8 Support: The entire project is optimized to ensure more stable performance when handling Chinese and other UTF-8 characters.
• Improved Windows Compatibility: Fixed multiple issues on the Windows operating system, enhancing the user experience.
• Enhanced Functional Modules:
  • More powerful file parsing capabilities.
  • Support for more file formats (e.g., PDF, PPTX, and XLSX).
  • Improved processing efficiency for YouTube videos.
• Enhanced Error Handling: Includes more detailed error logs and a custom output path function.

📚 Documentation

Key Differences from the Original Project

• Optimized UTF-8 Support: The original project had some issues in handling Chinese and other non - English characters, which have been fully improved in the current version.
• Enhanced Windows Support: Solved multiple problems encountered by Windows users during use.
• New Features: Provides more flexible environment variable configurations (e.g., UV_PATH and MARKDOWN_OUTPUT_DIR).

Functions

• Support for converting various file formats to Markdown:
  • DOCX
  • PDF
  • PPTX
  • XLSX
  • YouTube video links
  • Web page content
• Provide command - line tools and support for desktop application integration
• Compatible with Node.js and Python scripting environments

Usage Guide

Command - Line Usage

1. Convert a web page to Markdown

python convert_utf8.py "https://example.com"

2. Convert local files
   • DOCX files:

python convert_utf8.py "document.docx"

• PDF files:

python convert_utf8.py "document.pdf"

• PowerPoint files:

python convert_utf8.py "presentation.pptx"

• Excel files:

python convert_utf8.py "spreadsheet.xlsx"

3. Convert YouTube videos

python convert_utf8.py "https://www.youtube.com/watch?v=VIDEO_ID"

Batch Processing

1. Create a text file (e.g., convert_batch.txt) containing the URLs or file paths to be processed:

https://example1.com
https://example2.com
file1.docx
file2.pdf

2. Run the following command for batch processing:

while read -r line; do python convert_utf8.py "$line"; done < convert_batch.txt

Environment Variable Configuration

1. Set custom paths
   • Set the UV path:

export UV_PATH="/custom/path/to/uv"

• Set the output directory:

export MARKDOWN_OUTPUT_DIR="/output/path"

2. Use these environment variables in Python scripts.

Desktop Application Integration

1. Configure the Node.js environment

node dist/index.js

2. Python script call

import subprocess

def convert_file(file_path):
    subprocess.run(["python", "convert_utf8.py", file_path])

if __name__ == "__main__":
    file_path = input("Please enter the file path: ")
    convert_file(file_path)

⚠️ Important Note

• Ensure that the correct dependencies are installed. The Node.js and Python versions need to meet the requirements.
• Pay attention to performance when processing large files. Processing large PDF or PPT files may require more memory and time.
• Check the error logs. When encountering problems, view the detailed logs to quickly locate the issue.

🤝 Contribution and Feedback

Welcome to submit Pull Requests and Issues!

• Repository address: https://github.com/JDJR2024/markdownify-mcp-utf8
• For questions or suggestions, please contact: your.email@example.com

Thank you for your support! We hope this project will bring convenience to your work.