aboutsummaryrefslogtreecommitdiff
path: root/MANUAL.txt
diff options
context:
space:
mode:
authorAner Lucero <4rgento@gmail.com>2020-11-14 20:09:44 -0300
committerJohn MacFarlane <jgm@berkeley.edu>2020-11-14 21:33:32 -0800
commitf63b76e1698b0d7eba6b43ef45faaeee2b01b9ca (patch)
tree58e6458690ab189e00c15b98ccb88e440c97e396 /MANUAL.txt
parentb8d17f7ae8ed37784adcfaa4f89d0d28f52fffff (diff)
downloadpandoc-f63b76e1698b0d7eba6b43ef45faaeee2b01b9ca.tar.gz
Markdown writer: default to using ATX headings.
Previously we used Setext (underlined) headings by default. The default is now ATX (`##` style). * Add the `--markdown-headings=atx|setext` option. * Deprecate `--atx-headers`. * Add constructor 'ATXHeadingInLHS` constructor to `LogMessage` [API change]. * Support `markdown-headings` in defaults files. * Document new options in MANUAL. Closes #6662.
Diffstat (limited to 'MANUAL.txt')
-rw-r--r--MANUAL.txt19
1 files changed, 12 insertions, 7 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index 23ee62b5c..3af4aec58 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -963,21 +963,26 @@ header when requesting a document from a URL:
placement of link references is affected by the
`--reference-location` option.
-`--reference-location = block`|`section`|`document`
+`--reference-location=block`|`section`|`document`
: Specify whether footnotes (and references, if `reference-links` is
set) are placed at the end of the current (top-level) block, the
current section, or the document. The default is
`document`. Currently only affects the markdown writer.
+`--markdown-headings=setext`|`atx
+
+: Specify whether to use ATX-style (`#`-prefixed) or
+ Setext-style (underlined) headings for level 1 and 2
+ headings in Markdown output. (ATX is the default.)
+ ATX headings are always used for levels 3+.
+ This option also affects Markdown cells in `ipynb` output.
+
`--atx-headers`
-: Use ATX-style headings in Markdown output. The default is
- to use setext-style headings for levels 1 to 2, and then ATX headings.
- (Note: for `gfm` output, ATX headings are always used.)
- This option also affects markdown cells in `ipynb` output.
+: *Deprecated synonym for `--markdown-headings=atx`.*
-`--top-level-division=[default|section|chapter|part]`
+`--top-level-division=default`|`section`|`chapter`|`part`
: Treat top-level headings as the given division type in LaTeX, ConTeXt,
DocBook, and TEI output. The hierarchy order is part, chapter, then section;
@@ -1624,7 +1629,7 @@ epub-cover-image: cover.jpg
reference-links: true
# block, section, or document
reference-location: block
-atx-headers: false
+markdown-headings: setext
# accept, reject, or all
track-changes: accept