mdmint 0.2.0rc1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mdmint-0.2.0rc1/LICENSE +201 -0
- mdmint-0.2.0rc1/NOTICE +5 -0
- mdmint-0.2.0rc1/PKG-INFO +196 -0
- mdmint-0.2.0rc1/README.md +164 -0
- mdmint-0.2.0rc1/mdmint/__init__.py +18 -0
- mdmint-0.2.0rc1/mdmint/__main__.py +6 -0
- mdmint-0.2.0rc1/mdmint/admonitions.py +70 -0
- mdmint-0.2.0rc1/mdmint/assets.py +84 -0
- mdmint-0.2.0rc1/mdmint/backends.py +244 -0
- mdmint-0.2.0rc1/mdmint/cli.py +164 -0
- mdmint-0.2.0rc1/mdmint/core.py +425 -0
- mdmint-0.2.0rc1/mdmint/docxtemplate.py +1250 -0
- mdmint-0.2.0rc1/mdmint/mathrender.py +114 -0
- mdmint-0.2.0rc1/mdmint/mermaid.py +149 -0
- mdmint-0.2.0rc1/mdmint/mkdocs.py +310 -0
- mdmint-0.2.0rc1/mdmint/render.py +343 -0
- mdmint-0.2.0rc1/mdmint/resources/default.css +122 -0
- mdmint-0.2.0rc1/mdmint.egg-info/PKG-INFO +196 -0
- mdmint-0.2.0rc1/mdmint.egg-info/SOURCES.txt +25 -0
- mdmint-0.2.0rc1/mdmint.egg-info/dependency_links.txt +1 -0
- mdmint-0.2.0rc1/mdmint.egg-info/entry_points.txt +2 -0
- mdmint-0.2.0rc1/mdmint.egg-info/requires.txt +17 -0
- mdmint-0.2.0rc1/mdmint.egg-info/top_level.txt +1 -0
- mdmint-0.2.0rc1/pyproject.toml +108 -0
- mdmint-0.2.0rc1/setup.cfg +4 -0
- mdmint-0.2.0rc1/tests/test_convert.py +287 -0
- mdmint-0.2.0rc1/tests/test_mkdocs_template.py +302 -0
mdmint-0.2.0rc1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or Derivative
|
|
95
|
+
Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Meaningful Data
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
mdmint-0.2.0rc1/NOTICE
ADDED
mdmint-0.2.0rc1/PKG-INFO
ADDED
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mdmint
|
|
3
|
+
Version: 0.2.0rc1
|
|
4
|
+
Summary: Export Markdown files to DOCX and/or PDF. Pure-Python, cross-platform, minimal dependencies.
|
|
5
|
+
Author-email: Antonio Olleros <antonio.olleros@meaningfuldata.eu>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/Meaningful-Data/mdmint
|
|
8
|
+
Keywords: markdown,docx,pdf,converter,export,mermaid,mkdocs,template
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
11
|
+
Classifier: Operating System :: OS Independent
|
|
12
|
+
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
13
|
+
Requires-Python: >=3.9
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
License-File: LICENSE
|
|
16
|
+
License-File: NOTICE
|
|
17
|
+
Requires-Dist: markdown-it-py>=3.0
|
|
18
|
+
Requires-Dist: mdit-py-plugins>=0.4
|
|
19
|
+
Requires-Dist: htmldocx>=0.0.6
|
|
20
|
+
Requires-Dist: python-docx>=1.1
|
|
21
|
+
Requires-Dist: xhtml2pdf>=0.2.11
|
|
22
|
+
Requires-Dist: svglib<1.6
|
|
23
|
+
Requires-Dist: PyYAML>=5.1
|
|
24
|
+
Provides-Extra: weasyprint
|
|
25
|
+
Requires-Dist: weasyprint>=60; extra == "weasyprint"
|
|
26
|
+
Provides-Extra: math
|
|
27
|
+
Requires-Dist: matplotlib>=3.5; extra == "math"
|
|
28
|
+
Provides-Extra: all
|
|
29
|
+
Requires-Dist: weasyprint>=60; extra == "all"
|
|
30
|
+
Requires-Dist: matplotlib>=3.5; extra == "all"
|
|
31
|
+
Dynamic: license-file
|
|
32
|
+
|
|
33
|
+
# mdmint
|
|
34
|
+
|
|
35
|
+
Export Markdown files to **DOCX** and/or **PDF** — pure-Python, cross-platform,
|
|
36
|
+
minimal dependencies.
|
|
37
|
+
|
|
38
|
+
A single Markdown → HTML pass feeds both writers. The two features that can't be
|
|
39
|
+
rendered statically in pure Python (mermaid diagrams and LaTeX math) use an
|
|
40
|
+
**optional** renderer if one is available and fall back gracefully otherwise — so
|
|
41
|
+
the base install stays small and works everywhere.
|
|
42
|
+
|
|
43
|
+
## Install
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pip install mdmint
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
The core install is pure-Python (no native libraries):
|
|
50
|
+
`markdown-it-py`, `mdit-py-plugins`, `htmldocx`/`python-docx`, `xhtml2pdf`.
|
|
51
|
+
|
|
52
|
+
Optional extras:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pip install "mdmint[math]" # render LaTeX math (adds matplotlib)
|
|
56
|
+
pip install "mdmint[weasyprint]" # higher-fidelity PDF (needs native Pango/Cairo)
|
|
57
|
+
pip install "mdmint[all]" # both of the above
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
For **mermaid diagrams**, install the mermaid CLI separately (optional):
|
|
61
|
+
`npm install -g @mermaid-js/mermaid-cli` (provides `mmdc`).
|
|
62
|
+
|
|
63
|
+
## Usage
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
mdmint notes.md # -> notes.pdf
|
|
67
|
+
mdmint notes.md -f docx,pdf -o out/ # both formats into ./out/
|
|
68
|
+
mdmint a.md b.md -f docx # -> a.docx and b.docx (one per input)
|
|
69
|
+
mdmint a.md b.md --merge -f pdf -o book.pdf # one merged PDF
|
|
70
|
+
mdmint report.md --toc -f pdf # insert a table of contents
|
|
71
|
+
mdmint report.md -f pdf --pdf-backend weasyprint
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
| Option | Meaning |
|
|
75
|
+
| ------ | ------- |
|
|
76
|
+
| `-f, --format` | `pdf`, `docx`, or both (comma-separated). Default `pdf`. |
|
|
77
|
+
| `-o, --output` | Output directory, or a file path. Default: alongside each input. |
|
|
78
|
+
| `--merge` | With multiple inputs, produce one merged file per format. |
|
|
79
|
+
| `--toc` | Insert a table of contents (or honour a `[TOC]` marker). |
|
|
80
|
+
| `--pdf-backend` | `xhtml2pdf` (default) or `weasyprint`. |
|
|
81
|
+
| `-v, --verbose` | Verbose logging. |
|
|
82
|
+
|
|
83
|
+
| `--mkdocs FILE` | Build one document from an mkdocs.yml `nav` (instead of INPUTs). |
|
|
84
|
+
| `--section-style` | With `--mkdocs`: `part` (default) or `heading` — see below. |
|
|
85
|
+
| `--template FILE` | Word template (`.docx`/`.dotx`) for DOCX output. |
|
|
86
|
+
| `--meta KEY=VALUE` | Value for a template `{{KEY}}` placeholder (repeatable). |
|
|
87
|
+
| `--style ROLE=STYLE` | Use a specific template style for a role (repeatable). |
|
|
88
|
+
|
|
89
|
+
Also runnable as `python -m mdmint ...`.
|
|
90
|
+
|
|
91
|
+
### From an mkdocs site
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
mdmint --mkdocs mkdocs.yml -f docx,pdf -o out/ # -> out/<site_name>.docx/.pdf
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
The `nav` decides which pages go in and in what order (without a `nav`, the
|
|
98
|
+
`docs_dir` tree is used, like mkdocs does). Sections become headings:
|
|
99
|
+
|
|
100
|
+
- `--section-style part` (default): a **top-level section** is a *part* divider
|
|
101
|
+
that doesn't use up a heading level, so its pages keep their `#` as chapters;
|
|
102
|
+
nested sections become `#`, `##`… and demote their pages to match.
|
|
103
|
+
- `--section-style heading`: every section is a heading one level above its pages.
|
|
104
|
+
|
|
105
|
+
Pages under a section titled *Annex(es)*, *Appendix* or *Appendices* become
|
|
106
|
+
appendix chapters. Links between pages (`../other/page.md#anchor`) become
|
|
107
|
+
in-document links; links to pages left out of the nav are kept as plain text.
|
|
108
|
+
Headings accept mkdocs `attr_list` syntax (`# Title {#id .part}`).
|
|
109
|
+
|
|
110
|
+
Settings can live in the mkdocs.yml itself (command-line options win):
|
|
111
|
+
|
|
112
|
+
```yaml
|
|
113
|
+
extra:
|
|
114
|
+
mdmint:
|
|
115
|
+
template: templates/brand.docx # relative to mkdocs.yml
|
|
116
|
+
section_style: part
|
|
117
|
+
status: Final # any other key fills {{STATUS}} etc.
|
|
118
|
+
confidentiality: Internal
|
|
119
|
+
styles: {code: "My Code Style"} # optional role overrides
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Branded DOCX with a Word template
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
mdmint report.md -f docx --template brand.docx --meta status=Draft
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
With `--template`, DOCX output is written *into a copy of the template*: its
|
|
129
|
+
cover, contents page, headers/footers, page setup and styles are kept, and the
|
|
130
|
+
content is appended at the end (or where a paragraph reading `{{CONTENT}}` sits).
|
|
131
|
+
Text like `{{TITLE}}`, `{{AUTHOR}}`, `{{DATE}}` anywhere in the body, headers or
|
|
132
|
+
footers is filled from, in increasing priority: mkdocs.yml (`site_name` → title,
|
|
133
|
+
`site_description` → subtitle, `site_author` → author, `extra.mdmint`), the Markdown
|
|
134
|
+
front matter, and `--meta`. `date` defaults to the current month; placeholders
|
|
135
|
+
left without a value are blanked with a warning.
|
|
136
|
+
|
|
137
|
+
Each element uses the template's styles, picking the first that exists:
|
|
138
|
+
|
|
139
|
+
| Role (`--style` key) | Styles tried |
|
|
140
|
+
| --- | --- |
|
|
141
|
+
| headings | `Heading 1`…`Heading N` (deeper levels reuse the last) |
|
|
142
|
+
| `part` / `appendix` | `Part Title` / `Appendix Heading` (else `Heading 1`) |
|
|
143
|
+
| `code` / `inline_code` | `Code Block`, `Source Code`, `HTML Preformatted` / `Inline Code`, `Verbatim Char`, `HTML Code` |
|
|
144
|
+
| `quote` | `Callout`, `Quote` (blockquotes) |
|
|
145
|
+
| `note` / `warning` | `Callout Note` / `Callout Warning` (admonitions, `> [!NOTE]`) |
|
|
146
|
+
| `table` | the template's own (non-stock) table style, else `Table Grid` |
|
|
147
|
+
| `table_heading` / `table_text` | `Table Heading` / `Table Text` |
|
|
148
|
+
| `figure` / `caption` | `Figure` / `Caption` ("Figure N." from the image alt text; `Table: …` before a table gives "Table N.") |
|
|
149
|
+
| lists | `List Bullet`, `List Number` (real multi-level numbering, restarted per list) |
|
|
150
|
+
| footnotes | `Footnote Text`/`Footnote Reference` (created if missing) — real Word footnotes |
|
|
151
|
+
|
|
152
|
+
How to build a template that styles well — required styles, numbering, placeholders, and a
|
|
153
|
+
specimen file to test it — is in [docs/TEMPLATES.md](docs/TEMPLATES.md).
|
|
154
|
+
|
|
155
|
+
Headings are bookmarked so in-document links work, and the template's TOC field
|
|
156
|
+
(if any) picks the headings up when Word updates fields on open. Without
|
|
157
|
+
`--template`, DOCX output is unchanged (htmldocx).
|
|
158
|
+
|
|
159
|
+
### Library API
|
|
160
|
+
|
|
161
|
+
```python
|
|
162
|
+
from mdmint import convert
|
|
163
|
+
|
|
164
|
+
convert(["report.md"], formats=["pdf", "docx"], output="out/")
|
|
165
|
+
convert(["a.md", "b.md"], formats=["pdf"], output="book.pdf", merge=True)
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
## Supported Markdown
|
|
169
|
+
|
|
170
|
+
CommonMark plus: GFM tables, task lists, strikethrough, footnotes, auto table of
|
|
171
|
+
contents, fenced code, [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)
|
|
172
|
+
(`!!! note` / `??? warning` callouts), embedded images (relative paths resolved
|
|
173
|
+
against the source file; remote URLs downloaded), LaTeX math, and mermaid diagrams.
|
|
174
|
+
|
|
175
|
+
## Notes & limitations
|
|
176
|
+
|
|
177
|
+
- **PDF backend.** `xhtml2pdf` (default) is pure-Python and runs anywhere, with a
|
|
178
|
+
pragmatic subset of CSS. `weasyprint` produces nicer output but needs native
|
|
179
|
+
Pango/Cairo libraries, so it is an opt-in extra.
|
|
180
|
+
- **Math** uses matplotlib's *mathtext* engine (a large LaTeX-math subset, no system
|
|
181
|
+
LaTeX required) rendered to images. Full LaTeX environments (e.g. `align`) are not
|
|
182
|
+
supported. Without matplotlib, math is shown as literal source with a warning.
|
|
183
|
+
- **Mermaid** requires the `mmdc` CLI. Without it, diagrams are shown as styled code
|
|
184
|
+
blocks with a warning. A snap-installed `mmdc` is supported (mdmint places its
|
|
185
|
+
scratch files where snap confinement can read them).
|
|
186
|
+
- **Admonitions** render as a colour-coded callout box (tinted background + accent
|
|
187
|
+
bar + coloured title) in both PDF and DOCX. Type icons are intentionally omitted:
|
|
188
|
+
the pure-Python PDF backend can't embed an emoji font, so colour and the title
|
|
189
|
+
carry the type instead. The collapsible `???`/`???+` blocks render fully expanded
|
|
190
|
+
(static documents have nothing to collapse into).
|
|
191
|
+
|
|
192
|
+
## License
|
|
193
|
+
|
|
194
|
+
Licensed under the [Apache License, Version 2.0](LICENSE).
|
|
195
|
+
|
|
196
|
+
Copyright 2026 Meaningful Data.
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# mdmint
|
|
2
|
+
|
|
3
|
+
Export Markdown files to **DOCX** and/or **PDF** — pure-Python, cross-platform,
|
|
4
|
+
minimal dependencies.
|
|
5
|
+
|
|
6
|
+
A single Markdown → HTML pass feeds both writers. The two features that can't be
|
|
7
|
+
rendered statically in pure Python (mermaid diagrams and LaTeX math) use an
|
|
8
|
+
**optional** renderer if one is available and fall back gracefully otherwise — so
|
|
9
|
+
the base install stays small and works everywhere.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pip install mdmint
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The core install is pure-Python (no native libraries):
|
|
18
|
+
`markdown-it-py`, `mdit-py-plugins`, `htmldocx`/`python-docx`, `xhtml2pdf`.
|
|
19
|
+
|
|
20
|
+
Optional extras:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
pip install "mdmint[math]" # render LaTeX math (adds matplotlib)
|
|
24
|
+
pip install "mdmint[weasyprint]" # higher-fidelity PDF (needs native Pango/Cairo)
|
|
25
|
+
pip install "mdmint[all]" # both of the above
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
For **mermaid diagrams**, install the mermaid CLI separately (optional):
|
|
29
|
+
`npm install -g @mermaid-js/mermaid-cli` (provides `mmdc`).
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
mdmint notes.md # -> notes.pdf
|
|
35
|
+
mdmint notes.md -f docx,pdf -o out/ # both formats into ./out/
|
|
36
|
+
mdmint a.md b.md -f docx # -> a.docx and b.docx (one per input)
|
|
37
|
+
mdmint a.md b.md --merge -f pdf -o book.pdf # one merged PDF
|
|
38
|
+
mdmint report.md --toc -f pdf # insert a table of contents
|
|
39
|
+
mdmint report.md -f pdf --pdf-backend weasyprint
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
| Option | Meaning |
|
|
43
|
+
| ------ | ------- |
|
|
44
|
+
| `-f, --format` | `pdf`, `docx`, or both (comma-separated). Default `pdf`. |
|
|
45
|
+
| `-o, --output` | Output directory, or a file path. Default: alongside each input. |
|
|
46
|
+
| `--merge` | With multiple inputs, produce one merged file per format. |
|
|
47
|
+
| `--toc` | Insert a table of contents (or honour a `[TOC]` marker). |
|
|
48
|
+
| `--pdf-backend` | `xhtml2pdf` (default) or `weasyprint`. |
|
|
49
|
+
| `-v, --verbose` | Verbose logging. |
|
|
50
|
+
|
|
51
|
+
| `--mkdocs FILE` | Build one document from an mkdocs.yml `nav` (instead of INPUTs). |
|
|
52
|
+
| `--section-style` | With `--mkdocs`: `part` (default) or `heading` — see below. |
|
|
53
|
+
| `--template FILE` | Word template (`.docx`/`.dotx`) for DOCX output. |
|
|
54
|
+
| `--meta KEY=VALUE` | Value for a template `{{KEY}}` placeholder (repeatable). |
|
|
55
|
+
| `--style ROLE=STYLE` | Use a specific template style for a role (repeatable). |
|
|
56
|
+
|
|
57
|
+
Also runnable as `python -m mdmint ...`.
|
|
58
|
+
|
|
59
|
+
### From an mkdocs site
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
mdmint --mkdocs mkdocs.yml -f docx,pdf -o out/ # -> out/<site_name>.docx/.pdf
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
The `nav` decides which pages go in and in what order (without a `nav`, the
|
|
66
|
+
`docs_dir` tree is used, like mkdocs does). Sections become headings:
|
|
67
|
+
|
|
68
|
+
- `--section-style part` (default): a **top-level section** is a *part* divider
|
|
69
|
+
that doesn't use up a heading level, so its pages keep their `#` as chapters;
|
|
70
|
+
nested sections become `#`, `##`… and demote their pages to match.
|
|
71
|
+
- `--section-style heading`: every section is a heading one level above its pages.
|
|
72
|
+
|
|
73
|
+
Pages under a section titled *Annex(es)*, *Appendix* or *Appendices* become
|
|
74
|
+
appendix chapters. Links between pages (`../other/page.md#anchor`) become
|
|
75
|
+
in-document links; links to pages left out of the nav are kept as plain text.
|
|
76
|
+
Headings accept mkdocs `attr_list` syntax (`# Title {#id .part}`).
|
|
77
|
+
|
|
78
|
+
Settings can live in the mkdocs.yml itself (command-line options win):
|
|
79
|
+
|
|
80
|
+
```yaml
|
|
81
|
+
extra:
|
|
82
|
+
mdmint:
|
|
83
|
+
template: templates/brand.docx # relative to mkdocs.yml
|
|
84
|
+
section_style: part
|
|
85
|
+
status: Final # any other key fills {{STATUS}} etc.
|
|
86
|
+
confidentiality: Internal
|
|
87
|
+
styles: {code: "My Code Style"} # optional role overrides
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Branded DOCX with a Word template
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
mdmint report.md -f docx --template brand.docx --meta status=Draft
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
With `--template`, DOCX output is written *into a copy of the template*: its
|
|
97
|
+
cover, contents page, headers/footers, page setup and styles are kept, and the
|
|
98
|
+
content is appended at the end (or where a paragraph reading `{{CONTENT}}` sits).
|
|
99
|
+
Text like `{{TITLE}}`, `{{AUTHOR}}`, `{{DATE}}` anywhere in the body, headers or
|
|
100
|
+
footers is filled from, in increasing priority: mkdocs.yml (`site_name` → title,
|
|
101
|
+
`site_description` → subtitle, `site_author` → author, `extra.mdmint`), the Markdown
|
|
102
|
+
front matter, and `--meta`. `date` defaults to the current month; placeholders
|
|
103
|
+
left without a value are blanked with a warning.
|
|
104
|
+
|
|
105
|
+
Each element uses the template's styles, picking the first that exists:
|
|
106
|
+
|
|
107
|
+
| Role (`--style` key) | Styles tried |
|
|
108
|
+
| --- | --- |
|
|
109
|
+
| headings | `Heading 1`…`Heading N` (deeper levels reuse the last) |
|
|
110
|
+
| `part` / `appendix` | `Part Title` / `Appendix Heading` (else `Heading 1`) |
|
|
111
|
+
| `code` / `inline_code` | `Code Block`, `Source Code`, `HTML Preformatted` / `Inline Code`, `Verbatim Char`, `HTML Code` |
|
|
112
|
+
| `quote` | `Callout`, `Quote` (blockquotes) |
|
|
113
|
+
| `note` / `warning` | `Callout Note` / `Callout Warning` (admonitions, `> [!NOTE]`) |
|
|
114
|
+
| `table` | the template's own (non-stock) table style, else `Table Grid` |
|
|
115
|
+
| `table_heading` / `table_text` | `Table Heading` / `Table Text` |
|
|
116
|
+
| `figure` / `caption` | `Figure` / `Caption` ("Figure N." from the image alt text; `Table: …` before a table gives "Table N.") |
|
|
117
|
+
| lists | `List Bullet`, `List Number` (real multi-level numbering, restarted per list) |
|
|
118
|
+
| footnotes | `Footnote Text`/`Footnote Reference` (created if missing) — real Word footnotes |
|
|
119
|
+
|
|
120
|
+
How to build a template that styles well — required styles, numbering, placeholders, and a
|
|
121
|
+
specimen file to test it — is in [docs/TEMPLATES.md](docs/TEMPLATES.md).
|
|
122
|
+
|
|
123
|
+
Headings are bookmarked so in-document links work, and the template's TOC field
|
|
124
|
+
(if any) picks the headings up when Word updates fields on open. Without
|
|
125
|
+
`--template`, DOCX output is unchanged (htmldocx).
|
|
126
|
+
|
|
127
|
+
### Library API
|
|
128
|
+
|
|
129
|
+
```python
|
|
130
|
+
from mdmint import convert
|
|
131
|
+
|
|
132
|
+
convert(["report.md"], formats=["pdf", "docx"], output="out/")
|
|
133
|
+
convert(["a.md", "b.md"], formats=["pdf"], output="book.pdf", merge=True)
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Supported Markdown
|
|
137
|
+
|
|
138
|
+
CommonMark plus: GFM tables, task lists, strikethrough, footnotes, auto table of
|
|
139
|
+
contents, fenced code, [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)
|
|
140
|
+
(`!!! note` / `??? warning` callouts), embedded images (relative paths resolved
|
|
141
|
+
against the source file; remote URLs downloaded), LaTeX math, and mermaid diagrams.
|
|
142
|
+
|
|
143
|
+
## Notes & limitations
|
|
144
|
+
|
|
145
|
+
- **PDF backend.** `xhtml2pdf` (default) is pure-Python and runs anywhere, with a
|
|
146
|
+
pragmatic subset of CSS. `weasyprint` produces nicer output but needs native
|
|
147
|
+
Pango/Cairo libraries, so it is an opt-in extra.
|
|
148
|
+
- **Math** uses matplotlib's *mathtext* engine (a large LaTeX-math subset, no system
|
|
149
|
+
LaTeX required) rendered to images. Full LaTeX environments (e.g. `align`) are not
|
|
150
|
+
supported. Without matplotlib, math is shown as literal source with a warning.
|
|
151
|
+
- **Mermaid** requires the `mmdc` CLI. Without it, diagrams are shown as styled code
|
|
152
|
+
blocks with a warning. A snap-installed `mmdc` is supported (mdmint places its
|
|
153
|
+
scratch files where snap confinement can read them).
|
|
154
|
+
- **Admonitions** render as a colour-coded callout box (tinted background + accent
|
|
155
|
+
bar + coloured title) in both PDF and DOCX. Type icons are intentionally omitted:
|
|
156
|
+
the pure-Python PDF backend can't embed an emoji font, so colour and the title
|
|
157
|
+
carry the type instead. The collapsible `???`/`???+` blocks render fully expanded
|
|
158
|
+
(static documents have nothing to collapse into).
|
|
159
|
+
|
|
160
|
+
## License
|
|
161
|
+
|
|
162
|
+
Licensed under the [Apache License, Version 2.0](LICENSE).
|
|
163
|
+
|
|
164
|
+
Copyright 2026 Meaningful Data.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""mdmint — export Markdown files to DOCX and/or PDF.
|
|
2
|
+
|
|
3
|
+
Pure-Python, cross-platform, minimal dependencies. The two features that cannot
|
|
4
|
+
be rendered statically in pure Python — mermaid diagrams and LaTeX math — use an
|
|
5
|
+
optional renderer if present and fall back gracefully (with a warning) otherwise.
|
|
6
|
+
|
|
7
|
+
Public API
|
|
8
|
+
----------
|
|
9
|
+
from mdmint import convert, MarkdownConverter
|
|
10
|
+
|
|
11
|
+
convert(["doc.md"], formats=["pdf", "docx"], output="out/")
|
|
12
|
+
convert_mkdocs("mkdocs.yml", formats=["docx"], template="brand.docx")
|
|
13
|
+
"""
|
|
14
|
+
|
|
15
|
+
from .core import MarkdownConverter, convert, convert_mkdocs
|
|
16
|
+
|
|
17
|
+
__version__ = "0.2.0rc1"
|
|
18
|
+
__all__ = ["MarkdownConverter", "convert", "convert_mkdocs", "__version__"]
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"""Shared colour table for Markdown admonitions (``!!!`` / ``???`` callouts).
|
|
2
|
+
|
|
3
|
+
Both writers need to agree on what a "warning" looks like, but they style it
|
|
4
|
+
through completely different mechanisms: :mod:`mdmint.render` emits inline CSS that
|
|
5
|
+
the PDF backend honours, while :mod:`mdmint.backends` paints the DOCX cell with
|
|
6
|
+
low-level OOXML after the fact. Keeping the palette here means the two paths can
|
|
7
|
+
never drift, and adding a type is a one-line change.
|
|
8
|
+
|
|
9
|
+
Type names follow python-markdown / mkdocs-Material conventions; unknown tags
|
|
10
|
+
degrade to the neutral ``note`` styling rather than raising.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from __future__ import annotations
|
|
14
|
+
|
|
15
|
+
# Canonical type -> (accent colour, light background tint), both ``#rrggbb``.
|
|
16
|
+
_CANONICAL: dict[str, tuple[str, str]] = {
|
|
17
|
+
"note": ("#448aff", "#eaf1ff"),
|
|
18
|
+
"abstract": ("#00b0ff", "#e5f6ff"),
|
|
19
|
+
"info": ("#00b8d4", "#e3f8fc"),
|
|
20
|
+
"tip": ("#00bfa5", "#e3f8f4"),
|
|
21
|
+
"success": ("#00c853", "#e6f9ec"),
|
|
22
|
+
"question": ("#64dd17", "#eef9e3"),
|
|
23
|
+
"warning": ("#ff9100", "#fff3e0"),
|
|
24
|
+
"failure": ("#ff5252", "#ffecec"),
|
|
25
|
+
"danger": ("#ff1744", "#ffe9ed"),
|
|
26
|
+
"bug": ("#f50057", "#ffe6ef"),
|
|
27
|
+
"example": ("#7c4dff", "#f0ebff"),
|
|
28
|
+
"quote": ("#9e9e9e", "#f5f5f5"),
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
# Extra spellings mkdocs/python-markdown accept, mapped to a canonical key.
|
|
32
|
+
_ALIASES: dict[str, str] = {
|
|
33
|
+
"summary": "abstract",
|
|
34
|
+
"tldr": "abstract",
|
|
35
|
+
"hint": "tip",
|
|
36
|
+
"important": "tip",
|
|
37
|
+
"check": "success",
|
|
38
|
+
"done": "success",
|
|
39
|
+
"help": "question",
|
|
40
|
+
"faq": "question",
|
|
41
|
+
"caution": "warning",
|
|
42
|
+
"attention": "warning",
|
|
43
|
+
"fail": "failure",
|
|
44
|
+
"missing": "failure",
|
|
45
|
+
"error": "danger",
|
|
46
|
+
"cite": "quote",
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
DEFAULT = "note"
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def resolve(tag: str) -> str:
|
|
53
|
+
"""Map any admonition tag (or alias) to a canonical key, defaulting to note."""
|
|
54
|
+
tag = (tag or "").strip().lower()
|
|
55
|
+
if tag in _CANONICAL:
|
|
56
|
+
return tag
|
|
57
|
+
return _ALIASES.get(tag, DEFAULT)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
def style_for(tag: str) -> tuple[str, str]:
|
|
61
|
+
"""Return ``(accent, background)`` hex colours for an admonition tag."""
|
|
62
|
+
return _CANONICAL[resolve(tag)]
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
# Accent colour (upper-case, no ``#``) -> canonical type. The DOCX post-pass uses
|
|
66
|
+
# this to recognise an admonition table by its title colour, which is the only
|
|
67
|
+
# marker that survives htmldocx's class-stripping conversion.
|
|
68
|
+
ACCENTS: dict[str, str] = {
|
|
69
|
+
accent.lstrip("#").upper(): key for key, (accent, _bg) in _CANONICAL.items()
|
|
70
|
+
}
|