git.iko.soy/typeable/pandoc
on source_date_epoch help sign in
typeable/pandoc/README.template
89 lines 3.7 kB history raw
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-->
6Pandoc
7======
9[![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
10[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)
11[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)
12[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
13[![CI tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
14[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
15[![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
18The universal markup converter
19------------------------------
21Pandoc is a [Haskell] library for converting from one markup format to
22another, and a command-line tool that uses this library. It can convert *from*
24::: {#input-formats}
25:::
27It can convert *to*
29::: {#output-formats}
30:::
32Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
34Pandoc's enhanced version of Markdown includes syntax for tables,
35definition lists, metadata blocks, footnotes, citations, math,
36and much more. See the User's Manual below under
37[Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
39Pandoc has a modular design: it consists of a set of readers, which parse
40text in a given format and produce a native representation of the document
41(an _abstract syntax tree_ or AST), and a set of writers, which convert
42this native representation into a target format. Thus, adding an input
43or output format requires only adding a reader or writer. Users can also
44run custom pandoc filters to modify the intermediate AST (see
45the documentation for [filters](https://pandoc.org/filters.html)
46and [Lua filters](https://pandoc.org/lua-filters.html)).
48Because pandoc's intermediate representation of a document is less
49expressive than many of the formats it converts between, one should
50not expect perfect conversions between every format and every other.
51Pandoc attempts to preserve the structural elements of a document, but
52not formatting details such as margin size. And some document elements,
53such as complex tables, may not fit into pandoc's simple document
54model. While conversions from pandoc's Markdown to all formats aspire
55to be perfect, conversions from formats more expressive than pandoc's
56Markdown can be expected to be lossy.
59Installing
60----------
62Here's [how to install pandoc](INSTALL.md).
64Documentation
65-------------
67Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).
68It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.
69The website also contains some [examples of the use of
70pandoc](https://pandoc.org/demos.html) and a limited [online
71demo](https://pandoc.org/try).
73Contributing
74------------
76Pull requests, bug reports, and feature requests are welcome. Please make
77sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
78new issue.
81License
82-------
84© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the
85[GPL], version 2 or greater. This software carries no warranty of
86any kind. (See COPYRIGHT for full copyright and warranty notices.)
88[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
89[Haskell]: http://haskell.org