aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2015-02-08 21:29:39 +0000
committerMichael Williamson <mike@zwobble.org>2015-02-08 21:29:39 +0000
commit2230d84fb42f0ce4e3a5db9b346718b1411ed5a3 (patch)
tree4e74ae3051a1c1f7a2cef7b82de64dfa2b0ee5e7 /README.md
parent520aff9f8b49f7a578f0b04d77cc1dce2f3fb731 (diff)
Add markdown support to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1409360..9d08a38 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,16 @@ Where `custom-style-map` looks something like:
p[style-name='Aside Heading'] => div.aside > h2:fresh
p[style-name='Aside Text'] => div.aside > p:fresh
+#### Markdown
+
+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
@@ -194,6 +204,12 @@ Converts the source document to HTML.
* `messages`: any messages, such as errors and warnings, generated during the conversion
+#### `mammoth.convert_to_markdown(*args, **kwargs)`
+
+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.
+
#### `mammoth.extract_raw_text(fileobj)`
Extract the raw text of the document.