Universal markup converter
Clone or download
jgm Add .options class to option headers in manual.
This will allow autogeneration of ids for particular
options in the manual.
Latest commit 6632f2f Sep 18, 2018
Permalink
Failed to load latest commit information.
.github ISSUE_TEMPLATE: add URL for pandoc-discuss. Mar 13, 2017
benchmark Added Prelude imports to sources in benchmark and trypandoc. Mar 18, 2018
data Make HTML5 header easier to style precisely in default template (#4767) Sep 10, 2018
doc lua-filters.md: add links to filters, and to lua-filters repository. Sep 7, 2018
linux linux/Dockerfile: Use more recent (unofficial) stack. Sep 17, 2018
macos Removed stack.pkg.yaml. Dec 28, 2017
man Update manual date and man page. Sep 16, 2018
prelude New approach to custom Prelude. Mar 18, 2018
src/Text parse rST inlines containing newlines closing #4912 Sep 18, 2018
test parse rST inlines containing newlines closing #4912 Sep 18, 2018
tools New README template, take in/out formats from manual. Apr 22, 2018
trypandoc More spellcheck Jul 2, 2018
windows Removed stack.pkg.yaml. Dec 28, 2017
.editorconfig .editorconfig: change tests/ to test/ as in 18ab864 Oct 27, 2017
.gitignore Added deb/.vagrant to gitignore Feb 1, 2017
.hlint.yaml Add .hlint.yaml Oct 29, 2017
.stylish-haskell.yaml More spellcheck Jul 2, 2018
.travis.yml Another try at skipping round-trip tests in CI. Sep 13, 2018
AUTHORS.md Update changelog, AUTHORS.md. Sep 16, 2018
BUGS BUGS: Added reference to CONTRIBUTING.md. Apr 15, 2013
CONTRIBUTING.md CONTRIBUTING.md: link to lua-filters repository. Sep 7, 2018
COPYING.md Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
COPYRIGHT Add COPYRIGHT stanza for FB2 reader. May 4, 2018
INSTALL.md INSTALL.md: indicate that cabal >= 2.0 is needed. Sep 7, 2018
MANUAL.txt Add .options class to option headers in manual. Sep 18, 2018
Makefile Makefile: Fix executable path in trypandoc target. Sep 17, 2018
README.md Update README.md. Aug 5, 2018
README.template Fix Haskell link in README. Apr 27, 2018
RELEASE-CHECKLIST More RELEASE_CHECKLIST tweaks. Jan 8, 2018
Setup.hs Update copyright notices to include 2018 Jan 5, 2018
appveyor.yml Clean up appveyor build. Sep 7, 2018
changelog Update changelog. Sep 17, 2018
default.nix More spellcheck Jul 2, 2018
pandoc.cabal add test for --metadata-file Sep 15, 2018
pandoc.hs Use NoImplicitPrelude and explicitly import Prelude. Mar 18, 2018
stack.lts10.yaml Use released version of pandoc-citeproc (0.14.4). Sep 17, 2018
stack.lts11.yaml Use released version of pandoc-citeproc (0.14.4). Sep 17, 2018
stack.lts9.yaml Use released version of pandoc-citeproc (0.14.4). Sep 17, 2018
stack.yaml Use released version of pandoc-citeproc (0.14.4). Sep 17, 2018

README.md

Pandoc

github release hackage release homebrew stackage LTS package travis build status appveyor build status license pandoc-discuss on google groups

The universal markup converter

Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library. It can convert from

It can convert to

Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.

Pandoc’s enhanced version of Markdown includes syntax for tables, definition lists, metadata blocks, footnotes, citations, math, and much more. See the User’s Manual below under Pandoc’s Markdown.

Pandoc has a modular design: it consists of a set of readers, which parse text in a given format and produce a native representation of the document (an abstract syntax tree or AST), and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer. Users can also run custom pandoc filters to modify the intermediate AST (see the documentation for filters and lua filters).

Because pandoc’s intermediate representation of a document is less expressive than many of the formats it converts between, one should not expect perfect conversions between every format and every other. Pandoc attempts to preserve the structural elements of a document, but not formatting details such as margin size. And some document elements, such as complex tables, may not fit into pandoc’s simple document model. While conversions from pandoc’s Markdown to all formats aspire to be perfect, conversions from formats more expressive than pandoc’s Markdown can be expected to be lossy.

Installing

Here’s how to install pandoc.

Documentation

Pandoc’s website contains a full User’s Guide. It is also available here as pandoc-flavored Markdown. The website also contains some examples of the use of pandoc and a limited online demo.

Contributing

Pull requests, bug reports, and feature requests are welcome. Please make sure to read the contributor guidelines before opening a new issue.

License

© 2006-2018 John MacFarlane (jgm@berkeley.edu). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)