summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-03-20 17:00:16 +0000
committerMichael Williamson <mike@zwobble.org>2014-03-20 17:00:16 +0000
commit2febcfe6ff0a92544ed03142ad57172dc4d06f14 (patch)
treec69add5cae76b99e0629138893eb5be4fee03736
parent96f8c88d6451befe02cf818298877b4f64994e37 (diff)
Add note on modifying document during transform
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1b60cf2..5da2fa7 100644
--- a/README.md
+++ b/README.md
@@ -153,6 +153,9 @@ var options = {
};
```
+The return value of `transformDocument` is used during HTML generation.
+The original document (and any child elements) can be safely modified.
+
### API
#### `mammoth.convertToHtml(input, options)`