summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2015-02-04 19:52:57 +0000
committerMichael Williamson <mike@zwobble.org>2015-02-04 19:52:57 +0000
commitafad2baba423b3d105c24ce8f305c9471d03e307 (patch)
tree40de04877e2fa8f9a88eb1f139b662197106adbb
parent6a45a896781650993628e5185994ad91a2d5b5b8 (diff)
Document Markdown support
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 58296b0..78f6f38 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,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
In node.js, mammoth can be required in the usual way:
@@ -299,6 +309,12 @@ Converts the source document to HTML.
* `messages`: any messages, such as errors and warnings, generated during the conversion
+#### `mammoth.convertToMarkdown(input, options)`
+
+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.
+
#### `mammoth.extractRawText(input)`
Extract the raw text of the document.