|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| _cabal_deps/ | H | 03-May-2022 | - | 1,344,441 | 1,128,686 |
| app/ | H | 30-Jun-2021 | - | 21 | 7 |
| benchmark/ | H | 30-Jun-2021 | - | 104 | 80 |
| citeproc/biblatex-localization/ | H | 30-Jun-2021 | - | 3,037 | 3,001 |
| data/ | H | 13-Aug-2021 | - | 8,918 | 7,835 |
| man/ | H | 30-Jun-2021 | - | 7,834 | 7,669 |
| prelude/ | H | 30-Jun-2021 | - | 16 | 8 |
| src/Text/ | H | 11-Mar-2021 | - | 77,563 | 62,029 |
| test/ | H | 03-May-2022 | - | 109,255 | 96,131 |
| trypandoc/ | H | 03-May-2022 | - | 92 | 69 |
| AUTHORS.md | H A D | 21-Aug-2021 | 5.3 KiB | 337 | 335 |
| BUGS | H A D | 07-Sep-2017 | 158 | 5 | 3 |
| CONTRIBUTING.md | H A D | 30-Jun-2021 | 19 KiB | 476 | 373 |
| COPYING.md | H A D | 30-Jun-2021 | 17.5 KiB | 361 | 295 |
| COPYRIGHT | H A D | 30-Jun-2021 | 8.2 KiB | 206 | 149 |
| INSTALL.md | H A D | 23-Jul-2021 | 13.9 KiB | 422 | 289 |
| README.md | H A D | 21-Aug-2021 | 11.3 KiB | 247 | 219 |
| Setup.hs | H A D | 30-Jun-2021 | 46 | 3 | 2 |
| cabal.project | H A D | 03-May-2022 | 5.2 KiB | 140 | 139 |
| changelog.md | H A D | 21-Aug-2021 | 867.5 KiB | | |
| pandoc.cabal | H A D | 21-Aug-2021 | 37.5 KiB | 850 | 835 |
| stack.yaml | H A D | 21-Aug-2021 | 391 | 24 | 21 |
README.md
1<!-- Do not edit this file. It is generated automatically from
2README.template and MANUAL.txt via the command:
3pandoc --lua-filter tools/update-readme.lua README.template -o README.md
4-->
5
6# Pandoc
7
8[![github
9release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
10[![hackage
11release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)
12[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)
13[![stackage LTS
14package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)
15[![CI
16tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
17[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
18[![pandoc-discuss on google
19groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
20
21## The universal markup converter
22
23Pandoc is a [Haskell](https://haskell.org) library for converting from
24one markup format to another, and a command-line tool that uses this
25library. It can convert *from*
26
27<div id="input-formats">
28
29- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)
30- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)
31- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
32- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
33 extensions)
34- `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))
35- `csljson` ([CSL
36 JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)
37 bibliography)
38- `csv` ([CSV](https://tools.ietf.org/html/rfc4180) table)
39- `docbook` ([DocBook](https://docbook.org))
40- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
41- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
42- `epub` ([EPUB](http://idpf.org/epub))
43- `fb2`
44 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
45 e-book)
46- `gfm` ([GitHub-Flavored
47 Markdown](https://help.github.com/articles/github-flavored-markdown/)),
48 or the deprecated and less accurate `markdown_github`; use
49 [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)
50 only if you need extensions not supported in
51 [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).
52- `haddock` ([Haddock
53 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
54- `html` ([HTML](https://www.w3.org/html/))
55- `ipynb` ([Jupyter
56 notebook](https://nbformat.readthedocs.io/en/latest/))
57- `jats` ([JATS](https://jats.nlm.nih.gov) XML)
58- `jira`
59 ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence
60 wiki markup)
61- `json` (JSON version of native AST)
62- `latex` ([LaTeX](https://www.latex-project.org/))
63- `markdown` ([Pandoc’s
64 Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))
65- `markdown_mmd`
66 ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))
67- `markdown_phpextra` ([PHP Markdown
68 Extra](https://michelf.ca/projects/php-markdown/extra/))
69- `markdown_strict` (original unextended
70 [Markdown](https://daringfireball.net/projects/markdown/))
71- `mediawiki` ([MediaWiki
72 markup](https://www.mediawiki.org/wiki/Help:Formatting))
73- `man` ([roff man](https://man.cx/groff_man(7)))
74- `muse` ([Muse](https://amusewiki.org/library/manual))
75- `native` (native Haskell)
76- `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))
77- `opml` ([OPML](http://dev.opml.org/spec2.html))
78- `org` ([Emacs Org mode](https://orgmode.org))
79- `rtf` ([Rich Text
80 Format](https://en.wikipedia.org/wiki/Rich_Text_Format))
81- `rst`
82 ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))
83- `t2t` ([txt2tags](https://txt2tags.org))
84- `textile` ([Textile](https://www.promptworks.com/textile))
85- `tikiwiki` ([TikiWiki
86 markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))
87- `twiki` ([TWiki
88 markup](https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))
89- `vimwiki` ([Vimwiki](https://vimwiki.github.io))
90
91</div>
92
93It can convert *to*
94
95<div id="output-formats">
96
97- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or
98 `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))
99- `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)
100- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)
101- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)
102- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
103- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
104 extensions)
105- `context` ([ConTeXt](https://www.contextgarden.net/))
106- `csljson` ([CSL
107 JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)
108 bibliography)
109- `docbook` or `docbook4` ([DocBook](https://docbook.org) 4)
110- `docbook5` (DocBook 5)
111- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
112- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
113- `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)
114- `epub2` (EPUB v2)
115- `fb2`
116 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
117 e-book)
118- `gfm` ([GitHub-Flavored
119 Markdown](https://help.github.com/articles/github-flavored-markdown/)),
120 or the deprecated and less accurate `markdown_github`; use
121 [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)
122 only if you need extensions not supported in
123 [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).
124- `haddock` ([Haddock
125 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
126- `html` or `html5` ([HTML](https://www.w3.org/html/),
127 i.e. [HTML5](https://html.spec.whatwg.org/)/XHTML [polyglot
128 markup](https://www.w3.org/TR/html-polyglot/))
129- `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)
130- `icml` ([InDesign
131 ICML](https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))
132- `ipynb` ([Jupyter
133 notebook](https://nbformat.readthedocs.io/en/latest/))
134- `jats_archiving` ([JATS](https://jats.nlm.nih.gov) XML, Archiving
135 and Interchange Tag Set)
136- `jats_articleauthoring` ([JATS](https://jats.nlm.nih.gov) XML,
137 Article Authoring Tag Set)
138- `jats_publishing` ([JATS](https://jats.nlm.nih.gov) XML, Journal
139 Publishing Tag Set)
140- `jats` (alias for `jats_archiving`)
141- `jira`
142 ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence
143 wiki markup)
144- `json` (JSON version of native AST)
145- `latex` ([LaTeX](https://www.latex-project.org/))
146- `man` ([roff man](https://man.cx/groff_man(7)))
147- `markdown` ([Pandoc’s
148 Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))
149- `markdown_mmd`
150 ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))
151- `markdown_phpextra` ([PHP Markdown
152 Extra](https://michelf.ca/projects/php-markdown/extra/))
153- `markdown_strict` (original unextended
154 [Markdown](https://daringfireball.net/projects/markdown/))
155- `mediawiki` ([MediaWiki
156 markup](https://www.mediawiki.org/wiki/Help:Formatting))
157- `ms` ([roff ms](https://man.cx/groff_ms(7)))
158- `muse` ([Muse](https://amusewiki.org/library/manual)),
159- `native` (native Haskell),
160- `odt` ([OpenOffice text
161 document](https://en.wikipedia.org/wiki/OpenDocument))
162- `opml` ([OPML](http://dev.opml.org/spec2.html))
163- `opendocument` ([OpenDocument](http://opendocument.xml.org))
164- `org` ([Emacs Org mode](https://orgmode.org))
165- `pdf` ([PDF](https://www.adobe.com/pdf/))
166- `plain` (plain text),
167- `pptx`
168 ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)
169 slide show)
170- `rst`
171 ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))
172- `rtf` ([Rich Text
173 Format](https://en.wikipedia.org/wiki/Rich_Text_Format))
174- `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))
175- `textile` ([Textile](https://www.promptworks.com/textile))
176- `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML
177 and JavaScript slide show)
178- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and
179 JavaScript slide show)
180- `dzslides` ([DZSlides](https://paulrouget.com/dzslides/) HTML5 +
181 JavaScript slide show),
182- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript
183 slide show)
184- `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript
185 slide show)
186- `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))
187- `xwiki` ([XWiki
188 markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))
189- `zimwiki` ([ZimWiki
190 markup](https://zim-wiki.org/manual/Help/Wiki_Syntax.html))
191- the path of a custom Lua writer, see [Custom
192 writers](https://pandoc.org/MANUAL.html#custom-writers) below
193
194</div>
195
196Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
197
198Pandoc’s enhanced version of Markdown includes syntax for tables,
199definition lists, metadata blocks, footnotes, citations, math, and much
200more. See the User’s Manual below under [Pandoc’s
201Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
202
203Pandoc has a modular design: it consists of a set of readers, which
204parse text in a given format and produce a native representation of the
205document (an *abstract syntax tree* or AST), and a set of writers, which
206convert this native representation into a target format. Thus, adding an
207input or output format requires only adding a reader or writer. Users
208can also run custom pandoc filters to modify the intermediate AST (see
209the documentation for [filters](https://pandoc.org/filters.html) and
210[Lua filters](https://pandoc.org/lua-filters.html)).
211
212Because pandoc’s intermediate representation of a document is less
213expressive than many of the formats it converts between, one should not
214expect perfect conversions between every format and every other. Pandoc
215attempts to preserve the structural elements of a document, but not
216formatting details such as margin size. And some document elements, such
217as complex tables, may not fit into pandoc’s simple document model.
218While conversions from pandoc’s Markdown to all formats aspire to be
219perfect, conversions from formats more expressive than pandoc’s Markdown
220can be expected to be lossy.
221
222## Installing
223
224Here’s [how to install pandoc](INSTALL.md).
225
226## Documentation
227
228Pandoc’s website contains a full [User’s
229Guide](https://pandoc.org/MANUAL.html). It is also available
230[here](MANUAL.txt) as pandoc-flavored Markdown. The website also
231contains some [examples of the use of
232pandoc](https://pandoc.org/demos.html) and a limited [online
233demo](https://pandoc.org/try).
234
235## Contributing
236
237Pull requests, bug reports, and feature requests are welcome. Please
238make sure to read [the contributor guidelines](CONTRIBUTING.md) before
239opening a new issue.
240
241## License
242
243© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the
244[GPL](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"),
245version 2 or greater. This software carries no warranty of any kind.
246(See COPYRIGHT for full copyright and warranty notices.)
247