From 511f6787dd943fc8a9321bd0e3464eb1e0eef11b Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Wed, 17 Jun 2015 15:12:49 +0100 Subject: Note that convertUnderline is deprecated in API section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 570651a..76dc8c6 100644 --- a/README.md +++ b/README.md @@ -315,7 +315,7 @@ Converts the source document to HTML. * `convertImage`: by default, images are converted to `` 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. -- cgit v1.2.3