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.5.tar.gz (13.6 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.5-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_md2docx-1.0.5.tar.gz
  • Upload date:
  • Size: 13.6 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.5.tar.gz
Algorithm Hash digest
SHA256 d0224d46cd46691fdcf99d8a295928e8b594e3df1cc1ae4d7e739c97b87e8114
MD5 474083346cf482682bd9396f3604d520
BLAKE2b-256 fb3e4ac0777e4d2a79823cc065e486ca316074644fdb2dab14b65a65e904e761

See more details on using hashes here.

File details

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

File metadata

  • Download URL: python_md2docx-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 18.3 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 715ff72a66c084f7a1fd5fad5952bffa0d98321b9c98850efbf023be0c871fc3
MD5 b4e62c35ad1cbb7267c2e4f22d864a13
BLAKE2b-256 f35ca7b18c51ed3c41d5f9cf4c02c14703d6d9f8f6ea23d35cf5f07c47be717b

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