Universal markup converter
Haskell HTML Groff Lua Shell Ruby Other
Permalink
Failed to load latest commit information.
benchmark Removed unused import. Nov 30, 2016
data We no longer need the MathMLInHTML.js shim from 2004! Dec 9, 2016
deb Use pandoc-citeproc 0.10.3 release in stack.yamls for binary pkgs. Nov 30, 2016
lib/fonts lib: Added symbol.txt and file to generate codepoint to unicode mapping Aug 10, 2014
man Update date in manual and man page. Nov 30, 2016
osx Use pandoc-citeproc 0.10.3 release in stack.yamls for binary pkgs. Nov 30, 2016
prelude Remove unnecessary CPP in custom Prelude. Sep 3, 2016
src/Text Docx reader: Ensure one-row tables don't have header. Dec 8, 2016
tests Docx reader: Ensure one-row tables don't have header. Dec 8, 2016
trypandoc trypandoc: call results 'html' instead of 'result'. Jun 8, 2016
windows Use pandoc-citeproc 0.10.3 release in stack.yamls for binary pkgs. Nov 30, 2016
.editorconfig Fix editorconfig for test files Apr 12, 2014
.gitignore Added INSTALL.md, incorporating INSTALL + installing page from website. Oct 25, 2016
.gitmodules .gitmodule: Use https rather than git URL. Jan 25, 2013
.travis.yml travis: use language generic (#3267) Nov 30, 2016
BUGS BUGS: Added reference to CONTRIBUTING.md. Apr 15, 2013
CONTRIBUTING.md CONTRIBUTING.md: minor change in wording and punctuation (#3252) Nov 24, 2016
COPYING.md Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
COPYRIGHT Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
HCAR-Pandoc.tex replace old url with pandoc.org Jun 9, 2015
INSTALL.md Removed duplicate link refs. Oct 25, 2016
Interact.hs Added note to Interact.hs recommending 'cabal repl'. Jan 6, 2014
MANUAL.txt MANUAL: better docs on how to create a custom reference.docx. Dec 7, 2016
Makefile Makefile: use stack. Dec 8, 2016
PROFILING Updated PROFILING instructions. Jul 8, 2010
README.md README.md: added link to INSTALL and examples and demo on website. Oct 25, 2016
RELEASE-CHECKLIST Small tweaks to release checklist. Dec 8, 2016
Setup.hs Setup.hs - removed some unneeded imports. Oct 18, 2016
appveyor.yml Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
changelog More cosmetic changes to changelog. Dec 1, 2016
extract-changes.hs Added 'make changes' target. Nov 15, 2015
github-upload.sh OSX package: Create .zip rather than .dmg. Dec 8, 2013
make_osx_package.sh Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
pandoc.cabal We no longer need the MathMLInHTML.js shim from 2004! Dec 9, 2016
pandoc.hs We no longer need the MathMLInHTML.js shim from 2004! Dec 9, 2016
stack.full.yaml Use lts-7.5 resolver. Oct 26, 2016
stack.yaml stack.yaml - use texmath 0.9 release. Nov 30, 2016

README.md

Pandoc

license hackage release stackage LTS package github release travis build status appveyor build status

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 read Markdown, CommonMark, PHP Markdown Extra, GitHub-Flavored Markdown, MultiMarkdown, and (subsets of) Textile, reStructuredText, HTML, LaTeX, MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs Org mode, DocBook, txt2tags, EPUB, ODT and Word docx; and it can write plain text, Markdown, CommonMark, PHP Markdown Extra, GitHub-Flavored Markdown, MultiMarkdown, reStructuredText, XHTML, HTML5, LaTeX (including beamer slide shows), ConTeXt, RTF, OPML, DocBook, OpenDocument, ODT, Word docx, GNU Texinfo, MediaWiki markup, DokuWiki markup, ZimWiki markup, Haddock markup, EPUB (v2 or v3), FictionBook2, Textile, groff man pages, Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, and Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows. It can also produce PDF output on systems where LaTeX, ConTeXt, or wkhtmltopdf is installed.

Pandoc's enhanced version of Markdown includes syntax for footnotes, tables, flexible ordered lists, definition lists, fenced code blocks, superscripts and subscripts, strikeout, metadata blocks, automatic tables of contents, embedded LaTeX math, citations, and Markdown inside HTML block elements. (These enhancements, described further under Pandoc's Markdown, can be disabled using the markdown_strict input or output format.)

In contrast to most existing tools for converting Markdown to HTML, which use regex substitutions, 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, 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.

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-2016 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.)