Update README.md, man page.

This commit is contained in:
John MacFarlane 2020-11-19 13:04:46 -08:00
parent b36ffef38e
commit 0c8ab8a12f
3 changed files with 28 additions and 30 deletions

View file

@ -1,7 +1,7 @@
--- ---
title: Pandoc User's Guide title: Pandoc User's Guide
author: John MacFarlane author: John MacFarlane
date: November 7, 2020 date: November 19, 2020
--- ---
# Synopsis # Synopsis

View file

@ -3,8 +3,7 @@ README.template and MANUAL.txt via the command:
pandoc --lua-filter tools/update-readme.lua README.template -o README.md pandoc --lua-filter tools/update-readme.lua README.template -o README.md
--> -->
Pandoc # Pandoc
======
[![github [![github
release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases) release](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
[![pandoc-discuss on google [![pandoc-discuss on google
groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss) groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
The universal markup converter ## The universal markup converter
------------------------------
Pandoc is a [Haskell](http://haskell.org) library for converting from Pandoc is a [Haskell](http://haskell.org) library for converting from
one markup format to another, and a command-line tool that uses this one markup format to another, and a command-line tool that uses this
@ -217,13 +215,11 @@ While conversions from pandocs Markdown to all formats aspire to be
perfect, conversions from formats more expressive than pandocs Markdown perfect, conversions from formats more expressive than pandocs Markdown
can be expected to be lossy. can be expected to be lossy.
Installing ## Installing
----------
Heres [how to install pandoc](INSTALL.md). Heres [how to install pandoc](INSTALL.md).
Documentation ## Documentation
-------------
Pandocs website contains a full [Users Pandocs website contains a full [Users
Guide](https://pandoc.org/MANUAL.html). It is also available Guide](https://pandoc.org/MANUAL.html). It is also available
@ -232,15 +228,13 @@ contains some [examples of the use of
pandoc](https://pandoc.org/demos.html) and a limited [online pandoc](https://pandoc.org/demos.html) and a limited [online
demo](https://pandoc.org/try). demo](https://pandoc.org/try).
Contributing ## Contributing
------------
Pull requests, bug reports, and feature requests are welcome. Please Pull requests, bug reports, and feature requests are welcome. Please
make sure to read [the contributor guidelines](CONTRIBUTING.md) before make sure to read [the contributor guidelines](CONTRIBUTING.md) before
opening a new issue. opening a new issue.
License ## License
-------
© 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the © 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the
[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"), [GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),

View file

@ -1,7 +1,7 @@
'\" t '\" t
.\" Automatically generated by Pandoc 2.11.1 .\" Automatically generated by Pandoc 2.11.2
.\" .\"
.TH "Pandoc User\[cq]s Guide" "" "November 7, 2020" "pandoc 2.11.1.1" "" .TH "Pandoc User\[cq]s Guide" "" "November 19, 2020" "pandoc 2.11.2" ""
.hy .hy
.SH NAME .SH NAME
pandoc - general markup converter pandoc - general markup converter
@ -1000,21 +1000,24 @@ By default inline links are used.
The placement of link references is affected by the The placement of link references is affected by the
\f[C]--reference-location\f[R] option. \f[C]--reference-location\f[R] option.
.TP .TP
\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] \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]
Specify whether footnotes (and references, if \f[C]reference-links\f[R] Specify whether footnotes (and references, if \f[C]reference-links\f[R]
is set) are placed at the end of the current (top-level) block, the is set) are placed at the end of the current (top-level) block, the
current section, or the document. current section, or the document.
The default is \f[C]document\f[R]. The default is \f[C]document\f[R].
Currently only affects the markdown writer. Currently only affects the markdown writer.
.TP .TP
\f[B]\f[CB]--atx-headers\f[B]\f[R] \f[B]\f[CB]--markdown-headings=setext\f[B]\f[R]|\f[B]\f[CB]atx\f[B]\f[R]
Use ATX-style headings in Markdown output. Specify whether to use ATX-style (\f[C]#\f[R]-prefixed) or Setext-style
The default is to use setext-style headings for levels 1 to 2, and then (underlined) headings for level 1 and 2 headings in Markdown output.
ATX headings. (The default is \f[C]atx\f[R].) ATX-style headings are always used for
(Note: for \f[C]gfm\f[R] output, ATX headings are always used.) This levels 3+.
option also affects markdown cells in \f[C]ipynb\f[R] output. This option also affects Markdown cells in \f[C]ipynb\f[R] output.
.TP .TP
\f[B]\f[CB]--top-level-division=[default|section|chapter|part]\f[B]\f[R] \f[B]\f[CB]--atx-headers\f[B]\f[R]
\f[I]Deprecated synonym for \f[CI]--markdown-headings=atx\f[I].\f[R]
.TP
\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]
Treat top-level headings as the given division type in LaTeX, ConTeXt, Treat top-level headings as the given division type in LaTeX, ConTeXt,
DocBook, and TEI output. DocBook, and TEI output.
The hierarchy order is part, chapter, then section; all headings are The hierarchy order is part, chapter, then section; all headings are
@ -1839,7 +1842,7 @@ epub-cover-image: cover.jpg
reference-links: true reference-links: true
# block, section, or document # block, section, or document
reference-location: block reference-location: block
atx-headers: false markdown-headings: setext
# accept, reject, or all # accept, reject, or all
track-changes: accept track-changes: accept
@ -2365,7 +2368,8 @@ including a title block in the document itself, you can set the
\f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R] \f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R]
variables. variables.
(By default these are set automatically, based on \f[C]title\f[R], (By default these are set automatically, based on \f[C]title\f[R],
\f[C]author\f[R], and \f[C]date\f[R].) \f[C]author\f[R], and \f[C]date\f[R].) The page title in HTML is set by
\f[C]pagetitle\f[R], which is equal to \f[C]title\f[R] by default.
.RE .RE
.TP .TP
\f[B]\f[CB]subtitle\f[B]\f[R] \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]
\f[B]\f[CB]pdfa\f[B]\f[R] \f[B]\f[CB]pdfa\f[B]\f[R]
adds to the preamble the setup necessary to generate PDF/A of the type adds to the preamble the setup necessary to generate PDF/A of the type
specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R]. specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R].
If no type is specified (i.e.\ the value is set to True, by If no type is specified (i.e.\ the value is set to True, by e.g.
e.g.\ \f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML \f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML metadata
metadata block), \f[C]1b:2005\f[R] will be used as default, for reasons block), \f[C]1b:2005\f[R] will be used as default, for reasons of
of backwards compatibility. backwards compatibility.
Using \f[C]--variable=pdfa\f[R] without specified value is not Using \f[C]--variable=pdfa\f[R] without specified value is not
supported. supported.
To successfully generate PDF/A the required ICC color profiles have to To 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
.PP .PP
A few other metadata fields affect bibliography formatting: A few other metadata fields affect bibliography formatting:
.TP .TP
\f[B]\f[CB]link-citation\f[B]\f[R] \f[B]\f[CB]link-citations\f[B]\f[R]
If true, citations will be hyperlinked to the corresponding bibliography If true, citations will be hyperlinked to the corresponding bibliography
entries (for author-date and numerical styles only). entries (for author-date and numerical styles only).
.TP .TP