aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2020-04-17 16:22:44 +0100
committerMichael Williamson <mike@zwobble.org>2020-04-17 16:22:44 +0100
commitc0abf6d96a31c3e1c322ae5ccd8cd58c4a13e1b5 (patch)
treeeb360a15c5c4eff88fb29ac6dccbfbbf95c73b5a /README.md
parent0cd2f2ef233572e4b2795ecbfa7a4edd29fd8945 (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 37ae4c3..32fb7e9 100644
--- a/README.md
+++ b/README.md
@@ -108,14 +108,15 @@ Lines beginning with `#` will be ignored.
#### 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
In node.js, mammoth can be required in the usual way: