aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2022-05-02 19:55:19 +0100
committerMichael Williamson <mike@zwobble.org>2022-05-02 19:55:19 +0100
commit93eb38471f6a992df68bbc75a19d4703bf3f64a2 (patch)
tree390ecfca8ce9bb1e8d48ffed5dcdfc85fd144ced /README.md
parentfc1647e93b9ed151eb123e87f443fd2b3229cd83 (diff)
Add markdown deprecation notice to convertToMarkdown docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7772ff1..ad7ad69 100644
--- a/README.md
+++ b/README.md
@@ -381,6 +381,10 @@ Converts the source document to HTML.
#### `mammoth.convertToMarkdown(input, options)`
+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.
+
Converts the source document to Markdown.
This behaves the same as `convertToHtml`,
except that the `value` property of the result contains Markdown rather than HTML.