aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2020-04-17 16:23:02 +0100
committerMichael Williamson <mike@zwobble.org>2020-04-17 16:23:02 +0100
commit2070bba503c71fad576fb976cd212bacbe0004e5 (patch)
treec26b4604c47d20a140b6e2cbfaa4ba8422107135 /README.md
parent51e109968beb0c4f2fc4ac8524c3bbf1b74da369 (diff)
Deprecate Markdown support
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index b66ae91..2b58c48 100644
--- a/README.md
+++ b/README.md
@@ -98,14 +98,15 @@ Where `custom-style-map` looks something like:
#### Markdown
+Markdown support is deprecated.
+Generating HTML and using a separate library to convert the HTML to Markdown is recommended,
+and is likely to produce better results.
+
Using `--output-format=markdown` will cause Markdown to be generated.
For instance:
mammoth document.docx --output-format=markdown
-Markdown support is still in its early stages,
-so you may find some features are unsupported.
-
### Library
#### Basic conversion