summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2016-05-09 13:01:48 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2016-05-09 13:04:12 -0700
commit888a273c1bb47b55177c66db26acbbfd4585aee2 (patch)
treec17854e332b14fae686b2799df55316878afac5f
parentfd9ec835ec1447fb6040ee63a1fa8ee13b19d555 (diff)
README: clarified documentation of `implicit_header_references`.
Closes #2904.
-rw-r--r--README15
1 files changed, 10 insertions, 5 deletions
diff --git a/README b/README
index 2b8b38b9e..df18fcfb1 100644
--- a/README
+++ b/README
@@ -1591,21 +1591,26 @@ CSS.
#### Extension: `implicit_header_references` ####
Pandoc behaves as if reference links have been defined for each header.
-So, instead of
+So, to link to a header
- [header identifiers](#header-identifiers-in-html)
+ # Header identifiers in HTML
you can simply write
- [header identifiers]
+ [Header identifiers in HTML]
or
- [header identifiers][]
+ [Header identifiers in HTML][]
or
- [the section on header identifiers][header identifiers]
+ [the section on header identifiers][header identifiers in
+ HTML]
+
+instead of giving the identifier explicitly:
+
+ [Header identifiers in HTML](#header-identifiers-in-html)
If there are multiple headers with identical text, the corresponding
reference will link to the first one only, and you will need to use explicit