Universal markup converter
Haskell HTML Roff Lua Shell Ruby Other
Latest commit 9d91b88 Feb 25, 2017 @mb21 mb21 committed on GitHub CONTRIBUTING.md add "ask on pandoc-discuss"
Permalink
Failed to load latest commit information.
benchmark Fix stale references to `tests` directory (#3469) Feb 25, 2017
data default.revealjs template: make 'history' default to true. Feb 20, 2017
deb deb/make_deb.sh fixes. Feb 12, 2017
doc Added skeletons for docs on customizing pandoc and using pandoc API. Feb 1, 2017
lib/fonts lib: Added symbol.txt and file to generate codepoint to unicode mapping Aug 10, 2014
macos Replaced {deb,macos,windows}/stack.yaml with stack.pkg.yaml. Feb 12, 2017
man Updated man page. Jan 29, 2017
prelude Remove unnecessary CPP in custom Prelude. Sep 3, 2016
src/Text Fixed type sig for older GHC versions. Feb 25, 2017
test Added test case for variables/metadata in Markdown writer. Feb 25, 2017
tools Moved extract-changes.hs and github-upload.sh to tools/. Jan 25, 2017
trypandoc Adjustments for building trypandoc with stack. Jan 29, 2017
windows Windows packaging fixes to use new stack.pkg.yaml. Feb 12, 2017
.editorconfig Fix editorconfig for test files Apr 12, 2014
.gitignore Added deb/.vagrant to gitignore Feb 1, 2017
.gitmodules .gitmodule: Use https rather than git URL. Jan 25, 2013
.travis.yml Travis: move 7.8.4 out of allowed-failures. Feb 20, 2017
BUGS BUGS: Added reference to CONTRIBUTING.md. Apr 15, 2013
CONTRIBUTING.md CONTRIBUTING.md add "ask on pandoc-discuss" Feb 25, 2017
COPYING.md Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
COPYRIGHT Fix stale references to `tests` directory (#3469) Feb 25, 2017
INSTALL.md Fix stale references to `tests` directory (#3469) Feb 25, 2017
MANUAL.txt Add `sourcefile` and `outputfile` template variables (#3439) Feb 25, 2017
Makefile Makefile: make version overridable. Feb 7, 2017
README.md Rearrange and extend badges in README (#3354) Jan 15, 2017
RELEASE-CHECKLIST Modified documentation now that submodule fetching isn't needed. Feb 20, 2017
RELEASE-CHECKLIST.md Updated RELEASE-CHECKLIST and markdownified. Jan 25, 2017
Setup.hs Setup.hs - removed some unneeded imports. Oct 18, 2016
appveyor.yml appveyor.yml: Fixed some paths. Feb 12, 2017
changelog Updated changelog. Jan 29, 2017
pandoc.cabal Expose some unexposed modules. Feb 25, 2017
pandoc.hs Consolidated file arguments into Opt. Feb 6, 2017
stack.full.yaml Use lts-7.5 resolver. Oct 26, 2016
stack.pkg.yaml Use latest pandoc-citeproc commit in pkg.yaml. Feb 23, 2017
stack.yaml Use latest skylighting (0.3). Feb 20, 2017

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