@@ -3,7 +3,8 @@ README.template and MANUAL.txt via the command:
33pandoc --lua-filter tools/update-readme.lua README.template -o README.md
44-->
55
6−# Pandoc
6+Pandoc
7+======
78
89[](https://github.com/jgm/pandoc/releases)
@@ -19,7 +20,8 @@ tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://gi
1920[](https://groups.google.com/forum/#!forum/pandoc-discuss)
2122
22−## The universal markup converter
23+The universal markup converter
24+------------------------------
2325
2426Pandoc is a [Haskell](http://haskell.org) library for converting from
2527one markup format to another, and a command-line tool that uses this
@@ -27,58 +29,60 @@ library. It can convert *from*
2729
2830<div id="input-formats">
2931
30− - `commonmark` ([CommonMark](https://commonmark.org) Markdown)
31− - `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))
32− - `csv` ([CSV](https://tools.ietf.org/html/rfc4180) table)
33− - `docbook` ([DocBook](https://docbook.org))
34− - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
35− - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
36− - `epub` ([EPUB](http://idpf.org/epub))
37− - `fb2`
32+- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
33+- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
34+ extensions)
35+- `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))
36+- `csv` ([CSV](https://tools.ietf.org/html/rfc4180) table)
37+- `docbook` ([DocBook](https://docbook.org))
38+- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
39+- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
40+- `epub` ([EPUB](http://idpf.org/epub))
41+- `fb2`
3842 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
3943 e-book)
40− - `gfm` ([GitHub-Flavored
44+- `gfm` ([GitHub-Flavored
4145 Markdown](https://help.github.com/articles/github-flavored-markdown/)),
4246 or the deprecated and less accurate `markdown_github`; use
4347 [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)
4448 only if you need extensions not supported in
4549 [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).
46− - `haddock` ([Haddock
50+- `haddock` ([Haddock
4751 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
48− - `html` ([HTML](https://www.w3.org/html/))
49− - `ipynb` ([Jupyter
52+- `html` ([HTML](https://www.w3.org/html/))
53+- `ipynb` ([Jupyter
5054 notebook](https://nbformat.readthedocs.io/en/latest/))
51− - `jats` ([JATS](https://jats.nlm.nih.gov) XML)
52− - `jira`
55+- `jats` ([JATS](https://jats.nlm.nih.gov) XML)
56+- `jira`
5357 ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence
5458 wiki markup)
55− - `json` (JSON version of native AST)
56− - `latex` ([LaTeX](https://www.latex-project.org/))
57− - `markdown` ([Pandoc’s
59+- `json` (JSON version of native AST)
60+- `latex` ([LaTeX](https://www.latex-project.org/))
61+- `markdown` ([Pandoc’s
5862 Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))
59− - `markdown_mmd`
63+- `markdown_mmd`
6064 ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))
61− - `markdown_phpextra` ([PHP Markdown
65+- `markdown_phpextra` ([PHP Markdown
6266 Extra](https://michelf.ca/projects/php-markdown/extra/))
63− - `markdown_strict` (original unextended
67+- `markdown_strict` (original unextended
6468 [Markdown](https://daringfireball.net/projects/markdown/))
65− - `mediawiki` ([MediaWiki
69+- `mediawiki` ([MediaWiki
6670 markup](https://www.mediawiki.org/wiki/Help:Formatting))
67− - `man` ([roff man](https://man.cx/groff_man\(7\)))
68− - `muse` ([Muse](https://amusewiki.org/library/manual))
69− - `native` (native Haskell)
70− - `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))
71− - `opml` ([OPML](http://dev.opml.org/spec2.html))
72− - `org` ([Emacs Org mode](https://orgmode.org))
73− - `rst`
71+- `man` ([roff man](https://man.cx/groff_man(7)))
72+- `muse` ([Muse](https://amusewiki.org/library/manual))
73+- `native` (native Haskell)
74+- `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))
75+- `opml` ([OPML](http://dev.opml.org/spec2.html))
76+- `org` ([Emacs Org mode](https://orgmode.org))
77+- `rst`
7478 ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))
75− - `t2t` ([txt2tags](https://txt2tags.org))
76− - `textile` ([Textile](https://www.promptworks.com/textile))
77− - `tikiwiki` ([TikiWiki
79+- `t2t` ([txt2tags](https://txt2tags.org))
80+- `textile` ([Textile](https://www.promptworks.com/textile))
81+- `tikiwiki` ([TikiWiki
7882 markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))
79− - `twiki` ([TWiki
83+- `twiki` ([TWiki
8084 markup](https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))
81− - `vimwiki` ([Vimwiki](https://vimwiki.github.io))
85+- `vimwiki` ([Vimwiki](https://vimwiki.github.io))
8286
8387</div>
8488
@@ -86,94 +90,96 @@ It can convert *to*
8690
8791<div id="output-formats">
8892
89− - `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or
93+- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or
9094 `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))
91− - `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)
92− - `commonmark` ([CommonMark](https://commonmark.org) Markdown)
93− - `context` ([ConTeXt](https://www.contextgarden.net/))
94− - `docbook` or `docbook4` ([DocBook](https://docbook.org) 4)
95− - `docbook5` (DocBook 5)
96− - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
97− - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
98− - `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)
99− - `epub2` (EPUB v2)
100− - `fb2`
95+- `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)
96+- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
97+- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
98+ extensions)
99+- `context` ([ConTeXt](https://www.contextgarden.net/))
100+- `docbook` or `docbook4` ([DocBook](https://docbook.org) 4)
101+- `docbook5` (DocBook 5)
102+- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
103+- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
104+- `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)
105+- `epub2` (EPUB v2)
106+- `fb2`
101107 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
102108 e-book)
103− - `gfm` ([GitHub-Flavored
109+- `gfm` ([GitHub-Flavored
104110 Markdown](https://help.github.com/articles/github-flavored-markdown/)),
105111 or the deprecated and less accurate `markdown_github`; use
106112 [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)
107113 only if you need extensions not supported in
108114 [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).
109− - `haddock` ([Haddock
115+- `haddock` ([Haddock
110116 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
111− - `html` or `html5` ([HTML](https://www.w3.org/html/),
117+- `html` or `html5` ([HTML](https://www.w3.org/html/),
112118 i.e. [HTML5](https://html.spec.whatwg.org/)/XHTML [polyglot
113119 markup](https://www.w3.org/TR/html-polyglot/))
114− - `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)
115− - `icml` ([InDesign
120+- `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)
121+- `icml` ([InDesign
116122 ICML](https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))
117− - `ipynb` ([Jupyter
123+- `ipynb` ([Jupyter
118124 notebook](https://nbformat.readthedocs.io/en/latest/))
119− - `jats_archiving` ([JATS](https://jats.nlm.nih.gov) XML, Archiving
125+- `jats_archiving` ([JATS](https://jats.nlm.nih.gov) XML, Archiving
120126 and Interchange Tag Set)
121− - `jats_articleauthoring` ([JATS](https://jats.nlm.nih.gov) XML,
127+- `jats_articleauthoring` ([JATS](https://jats.nlm.nih.gov) XML,
122128 Article Authoring Tag Set)
123− - `jats_publishing` ([JATS](https://jats.nlm.nih.gov) XML, Journal
129+- `jats_publishing` ([JATS](https://jats.nlm.nih.gov) XML, Journal
124130 Publishing Tag Set)
125− - `jats` (alias for `jats_archiving`)
126− - `jira`
131+- `jats` (alias for `jats_archiving`)
132+- `jira`
127133 ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence
128134 wiki markup)
129− - `json` (JSON version of native AST)
130− - `latex` ([LaTeX](https://www.latex-project.org/))
131− - `man` ([roff man](https://man.cx/groff_man\(7\)))
132− - `markdown` ([Pandoc’s
135+- `json` (JSON version of native AST)
136+- `latex` ([LaTeX](https://www.latex-project.org/))
137+- `man` ([roff man](https://man.cx/groff_man(7)))
138+- `markdown` ([Pandoc’s
133139 Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))
134− - `markdown_mmd`
140+- `markdown_mmd`
135141 ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))
136− - `markdown_phpextra` ([PHP Markdown
142+- `markdown_phpextra` ([PHP Markdown
137143 Extra](https://michelf.ca/projects/php-markdown/extra/))
138− - `markdown_strict` (original unextended
144+- `markdown_strict` (original unextended
139145 [Markdown](https://daringfireball.net/projects/markdown/))
140− - `mediawiki` ([MediaWiki
146+- `mediawiki` ([MediaWiki
141147 markup](https://www.mediawiki.org/wiki/Help:Formatting))
142− - `ms` ([roff ms](https://man.cx/groff_ms\(7\)))
143− - `muse` ([Muse](https://amusewiki.org/library/manual)),
144− - `native` (native Haskell),
145− - `odt` ([OpenOffice text
148+- `ms` ([roff ms](https://man.cx/groff_ms(7)))
149+- `muse` ([Muse](https://amusewiki.org/library/manual)),
150+- `native` (native Haskell),
151+- `odt` ([OpenOffice text
146152 document](https://en.wikipedia.org/wiki/OpenDocument))
147− - `opml` ([OPML](http://dev.opml.org/spec2.html))
148− - `opendocument` ([OpenDocument](http://opendocument.xml.org))
149− - `org` ([Emacs Org mode](https://orgmode.org))
150− - `pdf` ([PDF](https://www.adobe.com/pdf/))
151− - `plain` (plain text),
152− - `pptx`
153+- `opml` ([OPML](http://dev.opml.org/spec2.html))
154+- `opendocument` ([OpenDocument](http://opendocument.xml.org))
155+- `org` ([Emacs Org mode](https://orgmode.org))
156+- `pdf` ([PDF](https://www.adobe.com/pdf/))
157+- `plain` (plain text),
158+- `pptx`
153159 ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)
154160 slide show)
155− - `rst`
161+- `rst`
156162 ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))
157− - `rtf` ([Rich Text
163+- `rtf` ([Rich Text
158164 Format](https://en.wikipedia.org/wiki/Rich_Text_Format))
159− - `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))
160− - `textile` ([Textile](https://www.promptworks.com/textile))
161− - `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML
165+- `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))
166+- `textile` ([Textile](https://www.promptworks.com/textile))
167+- `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML
162168 and JavaScript slide show)
163− - `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and
169+- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and
164170 JavaScript slide show)
165− - `dzslides` ([DZSlides](http://paulrouget.com/dzslides/) HTML5 +
171+- `dzslides` ([DZSlides](http://paulrouget.com/dzslides/) HTML5 +
166172 JavaScript slide show),
167− - `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript
173+- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript
168174 slide show)
169− - `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript
175+- `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript
170176 slide show)
171− - `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))
172− - `xwiki` ([XWiki
177+- `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))
178+- `xwiki` ([XWiki
173179 markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))
174− - `zimwiki` ([ZimWiki
180+- `zimwiki` ([ZimWiki
175181 markup](https://zim-wiki.org/manual/Help/Wiki_Syntax.html))
176− - the path of a custom Lua writer, see [Custom
182+- the path of a custom Lua writer, see [Custom
177183 writers](https://pandoc.org/MANUAL.html#custom-writers) below
178184
179185</div>
@@ -204,11 +210,13 @@ While conversions from pandoc’s Markdown to all formats aspire to be
204210perfect, conversions from formats more expressive than pandoc’s Markdown
205211can be expected to be lossy.
206212
207−## Installing
213+Installing
214+----------
208215
209216Here’s [how to install pandoc](INSTALL.md).
210217
211−## Documentation
218+Documentation
219+-------------
212220
213221Pandoc’s website contains a full [User’s
214222Guide](https://pandoc.org/MANUAL.html). It is also available
@@ -217,13 +225,15 @@ contains some [examples of the use of
217225pandoc](https://pandoc.org/demos.html) and a limited [online
218226demo](https://pandoc.org/try).
219227
220−## Contributing
228+Contributing
229+------------
221230
222231Pull requests, bug reports, and feature requests are welcome. Please
223232make sure to read [the contributor guidelines](CONTRIBUTING.md) before
224233opening a new issue.
225234
226−## License
235+License
236+-------
227237
228238© 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the
229239[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),