aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-07-06 17:45:34 +0100
committerMichael Williamson <mike@zwobble.org>2014-07-06 17:45:34 +0100
commit6b460ac78a503f41a46f81ee98bc743d9aa646e2 (patch)
tree3eaac638b530b55f2022d8c4ae5333c0e1170e9d /README.md
parentd914de2f659f3cd7d3774be8c1aeaab43564bd10 (diff)
Add supported features list
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 780dfad..e07a6ee 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,25 @@ There's a large mismatch between the structure used by .docx and the structure o
meaning that the conversion is unlikely to be perfect for more complicated documents.
Mammoth works best if you only use styles to semantically mark up your document.
+The following features are currently supported:
+
+* Headings.
+
+* Lists.
+
+* Customisable mapping from your own docx styles to HTML.
+ For instance, you can convert `WarningHeading` to `h1.warning`.
+
+* Tables.
+ The formatting of the table itself, such as borders, is currently ignored,
+ but the formatting of the text is treated the same as in the rest of the document.
+
+* Footnotes.
+
+* Images.
+
+* Bold and italics.
+
## Web demo
The easiest way to try out mammoth is to use the web demo: