Metadata-Version: 2.4
Name: python-md2docx
Version: 1.0.1
Summary: A user-friendly tool for converting Markdown to DOCX
Home-page: https://github.com/suqingdong/md2docx
Author: suqingdong
Author-email: suqingdong1114@gmail.com
License: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: loguru
Requires-Dist: pillow
Requires-Dist: requests
Requires-Dist: markdown
Requires-Dist: python-docx
Requires-Dist: pygments
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# A user-friendly tool for converting Markdown to DOCX

## Installation

```bash
pip install python-md2docx
```

## Usage

### Use in CMD

```bash
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

```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
- [x] Heading
- [x] Link
- [x] Image
- [x] Table
- [x] Inline Code
- [x] Code Block
- [x] Code Block as Image (pygments)
- [x] Quote
- [x] Checkbox
- [x] Mermaid

**Render Mermaid** based on [Mermaid Client(mmdc)](https://github.com/mermaid-js/mermaid-cli)
install it with: `npm install -g @mermaid-js/mermaid-cli`
