From afad2baba423b3d105c24ce8f305c9471d03e307 Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Wed, 4 Feb 2015 19:52:57 +0000 Subject: Document Markdown support --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) 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. -- cgit v1.2.3