Skip to main content

A user-friendly tool for converting Markdown to DOCX

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_md2docx-1.0.2.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_md2docx-1.0.2-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file python_md2docx-1.0.2.tar.gz.

File metadata

  • Download URL: python_md2docx-1.0.2.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for python_md2docx-1.0.2.tar.gz
Algorithm Hash digest
SHA256 3e34b7d4d3c74009b3ad836b3f6dda5e28a96bd99f4d84677d857c83606e08ca
MD5 d7760df751416ff38896ec585edb0835
BLAKE2b-256 88596fef14f420170700abea276c6475b741cc5d37d2ebedc79fa18acdc00f29

See more details on using hashes here.

File details

Details for the file python_md2docx-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: python_md2docx-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for python_md2docx-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 96dec6a691f8eb84a7f83900aa77dfcf16c9ee4e237755593b0b651ea46bef86
MD5 ba0af9e0e102d1e33bbd60f601a6bd7e
BLAKE2b-256 38236c840d5bf3463f330d638cad6a55f234f2dd3a8cbd77d698a315aa0caa76

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page