Skip to main content

A user-friendly tool for converting Markdown to DOCX

Installation

pip install python-md2docx

Usage

Use in CMD

md2docx --help

md2docx tests/demo.md -o tests/demo-default.docx
md2docx tests/demo.md -o tests/demo-code-as-image.docx --code-as-image
md2docx tests/demo.md -o tests/demo-render-mermaid.docx --render-mermaid 
md2docx tests/demo.md -o tests/demo-styles.docx --heading-color FF00FF --default-font Arial --chinese-font 微软雅黑

Use in Python

from md2docx.core import MD2DOCX

MD2DOCX().convert('tests/demo.md', output_file='tests/demo.docx')

MD2DOCX().convert(
    'tests/demo.md',
    output_file='tests/demo.docx',
    heading_color='FF00FF',
    default_font='Arial',
    chinese_font='微软雅黑',
    code_as_image=True,
)

Support Features

  • Heading
  • Link
  • Image
  • Table
  • Inline Code
  • Code Block
  • Code Block as Image (pygments)
  • Quote
  • Checkbox
  • Mermaid

Render Mermaid based on Mermaid Client(mmdc) install it with: npm install -g @mermaid-js/mermaid-cli

Metadata

Release files for python-md2docx 1.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-md2docx 1.0.5
File Size Uploaded
python_md2docx-1.0.5.tar.gz 13.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for python-md2docx 1.0.5
File Interpreter ABI Platform
python_md2docx-1.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 31.9 kB

Release files / python_md2docx-1.0.5.tar.gz

Download URL python_md2docx-1.0.5.tar.gz
Size 13.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d0224d46cd46691fdcf99d8a295928e8b594e3df1cc1ae4d7e739c97b87e8114
BLAKE2b-256 checksum
How to use checksums
fb3e4ac0777e4d2a79823cc065e486ca316074644fdb2dab14b65a65e904e761
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.8

Release files / python_md2docx-1.0.5-py3-none-any.whl

Download URL python_md2docx-1.0.5-py3-none-any.whl
Size 18.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
715ff72a66c084f7a1fd5fad5952bffa0d98321b9c98850efbf023be0c871fc3
BLAKE2b-256 checksum
How to use checksums
f35ca7b18c51ed3c41d5f9cf4c02c14703d6d9f8f6ea23d35cf5f07c47be717b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.8

Release history Release notifications | RSS feed

This release

1.0.5 This release

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page