Universal markup converter
Haskell HTML Groff Lua Shell Ruby Other
Latest commit 500de5e Aug 20, 2016 @tarleb tarleb Org writer: translate language identifiers
Pandoc and Org-mode use different programming language identifiers.  An
additional translation between those identifiers is added to avoid
unexpected behavior.  This fixes a problem where language specific
source code would sometimes be output as example code.
Failed to load latest commit information.
benchmark Fixed benchmark for new API. Dec 15, 2015
data Added `themeoptions` variable to beamer template (Carsten Gips). Aug 11, 2016
deb Use texmath 0.8.6.5. Closes #3040. Jul 24, 2016
lib/fonts lib: Added symbol.txt and file to generate codepoint to unicode mapping Aug 10, 2014
man Updated man page. Jul 15, 2016
osx Use texmath 0.8.6.5. Closes #3040. Jul 24, 2016
prelude Restored Text.Pandoc.Compat.Monoid. Nov 9, 2015
src/Text Org writer: translate language identifiers Aug 20, 2016
tests Org writer: ensure link targets are paths or URLs Aug 18, 2016
trypandoc trypandoc: call results 'html' instead of 'result'. Jun 8, 2016
windows Use texmath 0.8.6.5. Closes #3040. Jul 24, 2016
.editorconfig Fix editorconfig for test files Apr 12, 2014
.gitignore Rename README to MANUAL.txt Jul 20, 2016
.gitmodules .gitmodule: Use https rather than git URL. Jan 25, 2013
.travis.yml Fixed lts6 travis build. Jul 14, 2016
BUGS BUGS: Added reference to CONTRIBUTING.md. Apr 15, 2013
CONTRIBUTING.md Rename README to MANUAL.txt Jul 20, 2016
COPYING COPYING: Fixed sublist indentation. Feb 10, 2013
COPYRIGHT Update license year range to 2016 Jan 26, 2016
HCAR-Pandoc.tex replace old url with pandoc.org Jun 9, 2015
INSTALL Tell where to get tarball in INSTALL. Aug 10, 2016
Interact.hs Added note to Interact.hs recommending 'cabal repl'. Jan 6, 2014
MANUAL.txt Note in MANUAL that `--katex` works best with `html5`. Aug 20, 2016
Makefile Rename README to MANUAL.txt Jul 20, 2016
PROFILING Updated PROFILING instructions. Jul 8, 2010
README.md Fix the LaTeX and EPUB links Jul 29, 2016
RELEASE-CHECKLIST RELEASE-CHECKLIST - hint for more useful git log. May 23, 2016
Setup.hs Setup.hs: rewrite so as not to use process, directory, filepath. Oct 10, 2015
appveyor.yml Rename README to MANUAL.txt Jul 20, 2016
changelog Updated changelog. Jul 15, 2016
extract-changes.hs Added 'make changes' target. Nov 15, 2015
github-upload.sh OSX package: Create .zip rather than .dmg. Dec 8, 2013
googlecode-upload.sh OSX package: Create .zip rather than .dmg. Dec 8, 2013
make_osx_package.sh make_oxs_package.sh - use OSX env variable. Jul 14, 2016
make_travis_yml.hs Added 7.10.3 to make_travis_yml.hs known versions. Jan 5, 2016
pandoc.cabal Allow aeson 1.0.*. Aug 20, 2016
pandoc.hs synchronize spacing of footnotes in help output Aug 16, 2016
stack.full.yaml Added texmath 0.8.6.5. Jul 26, 2016
stack.hsb2hs.yaml Small changes in debian package creation. Jul 20, 2016
stack.lts6.yaml Use cmark-0.5.3.1 with stack.lts6.yaml. Jul 16, 2016
stack.yaml Use texmath 0.8.6.5. Closes #3040. Jul 24, 2016

README.md

Pandoc

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 in the manual 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.

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

Documentation

The full documentation can be found online and as pandoc-flavored Markdown in the file MANUAL.txt.

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