Metadata-Version: 2.1
Name: commentary
Version: 0.3.1
Summary: comment-preserving docx <-- --> markdown converter
Home-page: https://github.com/hdb/commentary
Author: Hudson Bailey
Author-email: hudsondiggsbailey@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pypandoc (>=1.4)
Requires-Dist: pandocfilters (==1.5.0)

# Commentary

Commentary is a command line document conversion tool and pandoc filter that preserves native-style comments between Markdown and docx files. <!-- this is a comment -->

## Installation

```bash
pip install commentary
```

## Basic Usage

```bash

echo 'Hello <!-- this is a comment --> world' > doc.md

# convert from md to docx using the CLI
commentary doc.md -o out.docx

# or invoke as a filter from pandoc
pandoc doc.md -F commentary-filter --wrap=none -o out.docx

# add metadata to your markdown comments
commentary doc.md -o doc.md

```

See [documentation](https://commentary.readthedocs.io/en/latest/usage.html) for full usage guide.


