summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2016-03-28 12:42:14 +0100
committerMichael Williamson <mike@zwobble.org>2016-03-28 13:29:03 +0100
commit241f56dd56ccda41bcecf95fdc0e069c516ca760 (patch)
tree691e093431eb29c7153fa2fbd60a50fd2fa63e3c
parent281770a47141e3743099257df04c5e109f10155d (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 a06168a..2620560 100644
--- a/NEWS
+++ b/NEWS
@@ -2,6 +2,8 @@
* Remove deprecated convert_underline argument.
+* 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 b1fd99e..c423581 100644
--- a/README.md
+++ b/README.md
@@ -257,6 +257,11 @@ Converts the source document to HTML.
* `ignore_empty_paragraphs`: by default, empty paragraphs are ignored.
Set this option to `False` to preserve empty paragraphs in the output.
+* `id_prefix`:
+ a string to prepend to any generated IDs,
+ such as those used by bookmarks, footnotes and endnotes.
+ Defaults to an empty string.
+
* Returns a result with the following properties:
* `value`: the generated HTML