Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/owez/mdcx

Seemless markdown to docx converter
https://github.com/owez/mdcx

converter docx markdown md

Last synced: 2 months ago
JSON representation

Seemless markdown to docx converter

Awesome Lists containing this project

README

        

# mdcx

Seamless markdown to docx converter.

## Example

Command-line:

```shell
$ mdcx hippo.md hippo.docx
```

In Python:

```python
from mdcx import Document

doc = Document("Markdown here!")
doc.save("example.docx")
```

## Installation

To install mdcx, simply download it from PyPI:

```shell
$ pip3 install mdcx
```

## Showcase

Here's a generated document from the `examples/` directory using the default theme:

![AirBnB Document](examples/images/airbnb.png)

## Roadmap

Here are the upcoming features for the development of mdcx:

- Markdown:
- [ ] Heading links
- [ ] Tables
- Quality-of-life
- [ ] Support `#` titles as well as the current yml titles
- [ ] Support a basic version of TOML `+++` metadata
- Extras:
- [ ] Local URIs become automatic managed appendixes

This project isn't finished as not all basic markdown has been implemented. The hope for this project is to be able to seamlessly convert all well-formatted markdown to a docx.