Universal markup converter
Clone or download
Permalink
Failed to load latest commit information.
.github ISSUE_TEMPLATE: add URL for pandoc-discuss. Mar 13, 2017
benchmark Update benchmarks for ghc 8.6.1. Oct 14, 2018
data LaTeX template: add variable romanfont (#4665) Nov 3, 2018
doc getting-started.md: Added title to test1.md to avoid warning. Nov 1, 2018
linux linux/Dockerfile - use resolver lts-12.12. Nov 4, 2018
macos Removed stack.pkg.yaml. Dec 28, 2017
man Update man/pandoc.1. Nov 4, 2018
prelude New approach to custom Prelude. Mar 18, 2018
src/Text HTML reader: parse `<small>` as a Span with class "small". Nov 16, 2018
test HTML reader: parse `<small>` as a Span with class "small". Nov 16, 2018
tools Added tools/changelog-helper.sh. Oct 3, 2018
trypandoc trypandoc: tweaked drop-down lists. Nov 4, 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 .travis.yml: test deriving via generics with GHC 8.4 Nov 4, 2018
AUTHORS.md Update AUTHORS.md. Nov 3, 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: Add chromeos install instructions (#4958) Oct 11, 2018
MANUAL.txt MANUAL: Under security, added note about +RTS option to limit heap size. Nov 15, 2018
Makefile Makefile: added full-cabal target. Oct 14, 2018
README.md Update README.md. Nov 3, 2018
README.template Fix Haskell link in README. Apr 27, 2018
RELEASE-CHECKLIST Added tools/changelog-helper.sh. Oct 3, 2018
Setup.hs Update copyright notices to include 2018 Jan 5, 2018
appveyor.yml appveyor - --verbose to diagnose problem. Oct 18, 2018
cabal.project Remove tag on pandoc-citeproc in cabal.project. Oct 19, 2018
changelog Fix typo in changelog. Nov 6, 2018
default.nix More spellcheck Jul 2, 2018
pandoc.cabal T.P.App: extract submodule T.P.App.FormatHeuristics Nov 7, 2018
pandoc.hs Use NoImplicitPrelude and explicitly import Prelude. Mar 18, 2018
stack.yaml Clean up stack.yaml, allow latest pandoc-citeproc. Nov 13, 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.)