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
9[](https://github.com/jgm/pandoc/releases)
10[](http://hackage.haskell.org/package/pandoc)
11[](http://brewformulas.org/Pandoc)
12[](http://stackage.org/lts/package/pandoc)
13[](https://circleci.com/gh/jgm/pandoc)
14[](https://github.com/jgm/pandoc/actions)
15[](https://ci.appveyor.com/project/jgm/pandoc)
16[](https://www.gnu.org/licenses/gpl.html)
17[](https://groups.google.com/forum/#!forum/pandoc-discuss)
20The universal markup converter
21------------------------------
23Pandoc is a [Haskell] library for converting from one markup format to
24another, and a command-line tool that uses this library. It can convert *from*
34Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
36Pandoc's enhanced version of Markdown includes syntax for tables,
37definition lists, metadata blocks, footnotes, citations, math,
38and much more. See the User's Manual below under
39[Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
41Pandoc has a modular design: it consists of a set of readers, which parse
42text in a given format and produce a native representation of the document
43(an _abstract syntax tree_ or AST), and a set of writers, which convert
44this native representation into a target format. Thus, adding an input
45or output format requires only adding a reader or writer. Users can also
46run custom pandoc filters to modify the intermediate AST (see
47the documentation for [filters](https://pandoc.org/filters.html)
48and [lua filters](https://pandoc.org/lua-filters.html)).
50Because pandoc's intermediate representation of a document is less
51expressive than many of the formats it converts between, one should
52not expect perfect conversions between every format and every other.
53Pandoc attempts to preserve the structural elements of a document, but
54not formatting details such as margin size. And some document elements,
55such as complex tables, may not fit into pandoc's simple document
56model. While conversions from pandoc's Markdown to all formats aspire
57to be perfect, conversions from formats more expressive than pandoc's
58Markdown can be expected to be lossy.
64Here's [how to install pandoc](INSTALL.md).
69Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).
70It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.
71The website also contains some [examples of the use of
72pandoc](https://pandoc.org/demos.html) and a limited [online
73demo](https://pandoc.org/try).
78Pull requests, bug reports, and feature requests are welcome. Please make
79sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
86© 2006-2018 John MacFarlane (jgm@berkeley.edu). Released under the
87[GPL], version 2 or greater. This software carries no warranty of
88any kind. (See COPYRIGHT for full copyright and warranty notices.)
90[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
91[Haskell]: http://haskell.org
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list