aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index b6ec286..f058aeb 100644
--- a/README.md
+++ b/README.md
@@ -306,6 +306,10 @@ Converts the source document to HTML.
#### `mammoth.convert_to_markdown(fileobj, **kwargs)`
+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 `convert_to_html`,
except that the `value` property of the result contains Markdown rather than HTML.