aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-01-07 22:35:04 +0000
committerMichael Williamson <mike@zwobble.org>2014-01-07 22:35:04 +0000
commit2ef857727a15d564d886654a9ae30d43fd6a8f30 (patch)
tree34e0938c135e5274b7104d06418f6857b097cdd5
parent82bc42ed38402e8015fd3150406ee655b4171604 (diff)
Document includeDefaultStyleMap in API section of README.md
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6b1a67d..098de8a 100644
--- a/README.md
+++ b/README.md
@@ -100,6 +100,11 @@ Converts the source document to HTML.
each element is expected to be the result of a call to `mammoth.style`.
See "Writing styles" for a reference to the syntax for styles.
+** `includeDefaultStyleMap`: by default,
+ the style map passed in `styleMap` is combined with the default style map.
+ To stop using the default style map altogether,
+ set `options.includeDefaultStyleMap` to `false`.
+
* Returns a promise containing a result.
This result has the following properties: