md2word

中文文档 | English

Convert Markdown files to Word documents (.docx) with extensive customization options.

Features

• Convert Markdown to Word documents
• Support for tables, code blocks, images, and more
• Automatic download and embedding of web images
• Automatic conversion of unsupported image formats (e.g., WebP)
• LaTeX formula support (converted to native Word equations)
• Configurable styles for headings, body text, and other elements
• Chinese font size support (e.g., "四号", "小四")
• Automatic heading numbering with multiple formats
• Optional table of contents generation

Installation

Using uv (recommended)

# Install globally
uv tool install md2word

# Or run directly without installation
uvx md2word input.md

Using pip

pip install md2word

Downloadable desktop app (no Python required)

If you prefer a GUI and do not want to install Python, you can download prebuilt executables from the GitHub Releases page. Look for the desktop app artifacts for Windows, macOS, and Linux, then unzip and run.

Usage

Command Line

# Basic conversion (outputs input.docx)
md2word input.md

# Specify output file
md2word input.md -o output.docx

# Use custom config file
md2word input.md -c my_config.json

# Add table of contents
md2word input.md --toc

# Custom TOC title and level
md2word input.md --toc --toc-title "Contents" --toc-level 4

# Generate default config file
md2word --init-config

As a Python Library

import md2word

# Simple conversion
md2word.convert_file("input.md", "output.docx")

# With custom configuration
config = md2word.Config.from_file("config.json")
md2word.convert_file("input.md", "output.docx", config=config, toc=True)

# Convert from string
markdown_content = "# Hello World\n\nThis is a test."
md2word.convert(markdown_content, "output.docx")

# Programmatic configuration
config = md2word.Config()
config.default_font = "Arial"
config.styles["heading_1"] = md2word.StyleConfig(
    font_name="Arial",
    font_size=24,
    bold=True,
    alignment="center",
    numbering_format="chapter",
)
md2word.convert_file("input.md", "output.docx", config=config)

Configuration

Create a config.json file to customize document styles.

Example Configuration

{
    "document": {
        "default_font": "Arial",
        "max_image_width_inches": 6.0
    },
    "styles": {
        "heading_1": {
            "font_name": "Arial",
            "font_size": 24,
            "bold": true,
            "alignment": "center",
            "line_spacing_rule": "exact",
            "line_spacing_value": 28,
            "numbering_format": "chapter"
        },
        "body": {
            "font_name": "Times New Roman",
            "font_size": 12,
            "alignment": "justify",
            "line_spacing_rule": "multiple",
            "line_spacing_value": 1.5,
            "first_line_indent": 2
        }
    }
}

Style Properties

Line Spacing Modes

Numbering Formats

Custom format strings are also supported using {n} for Arabic numbers and {cn} for Chinese numbers.

Table Configuration

Configure table appearance in the table section:

{
    "table": {
        "border_style": "single",
        "border_color": "000000",
        "border_width": 4,
        "header_background_color": "D9E2F3",
        "cell_background_color": null,
        "alternating_row_color": "F2F2F2",
        "cell_padding_top": 2,
        "cell_padding_bottom": 2,
        "cell_padding_left": 5,
        "cell_padding_right": 5,
        "width_mode": "full",
        "width_inches": null
    }
}

Chinese Font Sizes

Requirements

• Python >= 3.10
• markdown2
• python-docx
• html-for-docx
• httpx
• Pillow
• latex2mathml
• mathml2omml
• lxml

License

MIT