summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2016-03-28 12:55:11 +0100
committerMichael Williamson <mike@zwobble.org>2016-03-28 13:47:37 +0100
commit3afd698984f9ec3fcb9b16e5d6c12ea4a23dfb53 (patch)
tree7ff473e792381ce57c97b545337c2eb8b2e46be7
parent4a61edf08990a0ed8c243f9001d9069d7a644a50 (diff)
Officially support ID prefixes
-rw-r--r--NEWS2
-rw-r--r--README.md5
2 files changed, 7 insertions, 0 deletions
diff --git a/NEWS b/NEWS
index b373221..a0703d2 100644
--- a/NEWS
+++ b/NEWS
@@ -2,6 +2,8 @@
* Remove deprecated convertUnderline option.
+* Officially support ID prefixes.
+
* Generated IDs no longer insert a hyphen after the ID prefix.
* The default ID prefix is now the empty string rather than a random number
diff --git a/README.md b/README.md
index 05f19ed..00fa1b2 100644
--- a/README.md
+++ b/README.md
@@ -376,6 +376,11 @@ Converts the source document to HTML.
* `ignoreEmptyParagraphs`: by default, empty paragraphs are ignored.
Set this option to `false` to preserve empty paragraphs in the output.
+
+ * `idPrefix`:
+ a string to prepend to any generated IDs,
+ such as those used by bookmarks, footnotes and endnotes.
+ Defaults to an empty string.
* Returns a promise containing a result.
This result has the following properties: