PKG-INFO

Metadata-Version: 2.1
Name: Markdown2docx
Version: 0.1.0
Summary: Convert Markdown to docx with token substitution and command output substitution
Home-page: UNKNOWN
Author: Jeremy Lee
Author-email: jlee2.71818@gmail.com
License: MIT
Keywords: convert,markdown,docx,merge,tokens,substitution,development
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Text Processing :: Markup :: reStructuredText
Classifier: Topic :: Documentation
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENCE

# Markdown2docx

Table of Contents

## Purpose
Markdown2docx will take a plain text markdown document and create a Word .docx file.

#### Minimal Usage
```
from Markdown2docx import Markdown2docx
project = Markdown2docx('README')
project.eat_soup()
project.save()
```

You can optionally save a copy in HTML format alongside the .docx output, and print out the default styles.

```
from Markdown2docx import Markdown2docx
project = Markdown2docx('README')
project.eat_soup()
project.write_html()  # optional
print(type(project.styles()))
for k, v in project.styles().items():
    print(f'stylename: {k} = {v}')
project.save()
```

#### default styles
These are the default styles applied to the document:

* stylename: style_table = {'Medium Shading 1 Accent 3'}
* stylename: style_quote = {'Body Text'}
* stylename: style_body = {'Body Text'}
* stylename: style\_quote\_table = {'Table Grid'}
* stylename: toc_indicator = {'contents'}

## Token substitution and commands
For details about token substitution, refer to hello.md


## Create a table of contents.
The TOC will be inserted on the first and only the first match where a paragraph contains the TOC indicator. By default this is literally the word 'contents'. When the user opens the .docx document, it will display 'Right-click to update field.'

# For developers.
Use a virtualenv. For extra dev tools, use:

```
bash
$ pip install -e .[dev]
```