git.iko.soy/typeable/pandoc
on master help sign in
Update README.md, man page.
commit0c8ab8a12f69cdb2868ffe223aa938044fd447b4 authorJohn MacFarlane <jgm@berkeley.edu> dateThu 19 Nov 2020, 13:04 (6 years ago) parentb36ffef
3 files changed+27−29
compare with master
unifiedsplit
MANUAL.txt+1−1 README.md+6−12 man/pandoc.1+20−16
MANUAL.txt+1−1
@@ -1,7 +1,7 @@
11---
22title: Pandoc User's Guide
33author: John MacFarlane
4−date: November 7, 2020
4+date: November 19, 2020
55---
66
77# Synopsis
README.md+6−12
@@ -3,8 +3,7 @@ README.template and MANUAL.txt via the command:
33pandoc --lua-filter tools/update-readme.lua README.template -o README.md
44-->
55
6−Pandoc
7−======
6+# Pandoc
87
98[![github
109release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
@@ -19,8 +18,7 @@ tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://gi
1918[![pandoc-discuss on google
2019groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
2120
22−The universal markup converter
23−------------------------------
21+## The universal markup converter
2422
2523Pandoc is a [Haskell](http://haskell.org) library for converting from
2624one markup format to another, and a command-line tool that uses this
@@ -217,13 +215,11 @@ While conversions from pandoc’s Markdown to all formats aspire to be
217215perfect, conversions from formats more expressive than pandoc’s Markdown
218216can be expected to be lossy.
219217
220−Installing
221−----------
218+## Installing
222219
223220Here’s [how to install pandoc](INSTALL.md).
224221
225−Documentation
226−-------------
222+## Documentation
227223
228224Pandoc’s website contains a full [User’s
229225Guide](https://pandoc.org/MANUAL.html). It is also available
@@ -232,15 +228,13 @@ contains some [examples of the use of
232228pandoc](https://pandoc.org/demos.html) and a limited [online
233229demo](https://pandoc.org/try).
234230
235−Contributing
236−------------
231+## Contributing
237232
238233Pull requests, bug reports, and feature requests are welcome. Please
239234make sure to read [the contributor guidelines](CONTRIBUTING.md) before
240235opening a new issue.
241236
242−License
243−-------
237+## License
244238
245239© 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the
246240[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),
man/pandoc.1+20−16
@@ -1,7 +1,7 @@
11'\" t
2−.\" Automatically generated by Pandoc 2.11.1
2+.\" Automatically generated by Pandoc 2.11.2
33.\"
4−.TH "Pandoc User\[cq]s Guide" "" "November 7, 2020" "pandoc 2.11.1.1" ""
4+.TH "Pandoc User\[cq]s Guide" "" "November 19, 2020" "pandoc 2.11.2" ""
55.hy
66.SH NAME
77pandoc - general markup converter
@@ -1000,21 +1000,24 @@ By default inline links are used.
10001000The placement of link references is affected by the
10011001\f[C]--reference-location\f[R] option.
10021002.TP
1003−\f[B]\f[CB]--reference-location = block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
1003+\f[B]\f[CB]--reference-location=block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
10041004Specify whether footnotes (and references, if \f[C]reference-links\f[R]
10051005is set) are placed at the end of the current (top-level) block, the
10061006current section, or the document.
10071007The default is \f[C]document\f[R].
10081008Currently only affects the markdown writer.
10091009.TP
1010+\f[B]\f[CB]--markdown-headings=setext\f[B]\f[R]|\f[B]\f[CB]atx\f[B]\f[R]
1011+Specify whether to use ATX-style (\f[C]#\f[R]-prefixed) or Setext-style
1012+(underlined) headings for level 1 and 2 headings in Markdown output.
1013+(The default is \f[C]atx\f[R].) ATX-style headings are always used for
1014+levels 3+.
1015+This option also affects Markdown cells in \f[C]ipynb\f[R] output.
1016+.TP
10101017\f[B]\f[CB]--atx-headers\f[B]\f[R]
1011−Use ATX-style headings in Markdown output.
1012−The default is to use setext-style headings for levels 1 to 2, and then
1013−ATX headings.
1014−(Note: for \f[C]gfm\f[R] output, ATX headings are always used.) This
1015−option also affects markdown cells in \f[C]ipynb\f[R] output.
1018+\f[I]Deprecated synonym for \f[CI]--markdown-headings=atx\f[I].\f[R]
10161019.TP
1017−\f[B]\f[CB]--top-level-division=[default|section|chapter|part]\f[B]\f[R]
1020+\f[B]\f[CB]--top-level-division=default\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]chapter\f[B]\f[R]|\f[B]\f[CB]part\f[B]\f[R]
10181021Treat top-level headings as the given division type in LaTeX, ConTeXt,
10191022DocBook, and TEI output.
10201023The hierarchy order is part, chapter, then section; all headings are
@@ -1839,7 +1842,7 @@ epub-cover-image: cover.jpg
18391842reference-links: true
18401843# block, section, or document
18411844reference-location: block
1842−atx-headers: false
1845+markdown-headings: setext
18431846
18441847# accept, reject, or all
18451848track-changes: accept
@@ -2365,7 +2368,8 @@ including a title block in the document itself, you can set the
23652368\f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R]
23662369variables.
23672370(By default these are set automatically, based on \f[C]title\f[R],
2368−\f[C]author\f[R], and \f[C]date\f[R].)
2371+\f[C]author\f[R], and \f[C]date\f[R].) The page title in HTML is set by
2372+\f[C]pagetitle\f[R], which is equal to \f[C]title\f[R] by default.
23692373.RE
23702374.TP
23712375\f[B]\f[CB]subtitle\f[B]\f[R]
@@ -2888,10 +2892,10 @@ paper size, e.g.\ \f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R]
28882892\f[B]\f[CB]pdfa\f[B]\f[R]
28892893adds to the preamble the setup necessary to generate PDF/A of the type
28902894specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R].
2891−If no type is specified (i.e.\ the value is set to True, by
2892−e.g.\ \f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML
2893−metadata block), \f[C]1b:2005\f[R] will be used as default, for reasons
2894−of backwards compatibility.
2895+If no type is specified (i.e.\ the value is set to True, by e.g.
2896+\f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML metadata
2897+block), \f[C]1b:2005\f[R] will be used as default, for reasons of
2898+backwards compatibility.
28952899Using \f[C]--variable=pdfa\f[R] without specified value is not
28962900supported.
28972901To successfully generate PDF/A the required ICC color profiles have to
@@ -6314,7 +6318,7 @@ Bear in mind that bibliography files have to be in either BibTeX (for
63146318.PP
63156319A few other metadata fields affect bibliography formatting:
63166320.TP
6317−\f[B]\f[CB]link-citation\f[B]\f[R]
6321+\f[B]\f[CB]link-citations\f[B]\f[R]
63186322If true, citations will be hyperlinked to the corresponding bibliography
63196323entries (for author-date and numerical styles only).
63206324.TP