diff options
| author | Michael Williamson <mike@zwobble.org> | 2015-06-17 15:12:49 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2015-06-17 15:12:49 +0100 |
| commit | 511f6787dd943fc8a9321bd0e3464eb1e0eef11b (patch) | |
| tree | b89ac84c42359dbf9446a566ef688d96fbd0e9fe | |
| parent | a6ace91139254b72e74c874cadba527445dc0c6a (diff) | |
Note that convertUnderline is deprecated in API section
| -rw-r--r-- | README.md | 2 |
1 files changed, 1 insertions, 1 deletions
@@ -315,7 +315,7 @@ Converts the source document to HTML. * `convertImage`: by default, images are converted to `<img>` elements with the source included inline in the `src` attribute. Set this option to an [image converter](#image-converters) to override the default behaviour. - * `convertUnderline`: by default, the underlining of any text is ignored. + * `convertUnderline`: deprecated in favour of using style mappings to describe how to convert underlined text. Set this option to [`mammoth.underline.element(name)`](#underline) to override the default behaviour. * `ignoreEmptyParagraphs`: by default, empty paragraphs are ignored. |