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