diff options
| author | Michael Williamson <mike@zwobble.org> | 2022-05-02 19:56:02 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2022-05-02 19:56:02 +0100 |
| commit | 9b71a403e748db28b24637164cfa1155ad078396 (patch) | |
| tree | 5529a1d1531f04e66b2d26a1825636347d5b4f34 /README.md | |
| parent | 053276705542ad39ddec923943653d0db86d648b (diff) | |
Add markdown deprecation notice to convert_to_markdown docs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -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. |