/pandoc

Universal markup converter
  1. Haskell 91.4%
  2. HTML 5.4%
  3. Lua 1.4%
  4. Roff 1.3%
  5. Shell 0.2%
  6. Makefile 0.1%
  7. Other 0.2%
Haskell HTML Lua Roff Shell Makefile Other

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit cb7b0a6 May 25, 2017 @jgm Allow em for image height/width in HTML, LaTeX. 
- Export `inEm` from ImageSize [API change].
- Change `showFl` and `show` instance for `Dimension` so
  extra decimal places are omitted.
- Added `Em` as a constructor of `Dimension` [API change].
- Allow `em`, `cm`, `in` to pass through without conversion
  in HTML, LaTeX.

Closes #3450.
Permalink
Failed to load latest commit information.
.github ISSUE_TEMPLATE: add URL for pandoc-discuss. Mar 13, 2017
benchmark Fixed weigh-pandoc so it compiles again. Mar 15, 2017
data Docx writer: Use Table rather than "Table Normal" for table style. May 25, 2017
doc Document lua filters Apr 30, 2017
lib/fonts lib: Added symbol.txt and file to generate codepoint to unicode mapping Aug 10, 2014
linux Debian control: updated description. May 15, 2017
macos Revert "Revert "Use file-embed instead of hsb2hs to embed data files."" Apr 2, 2017
man Updated man page. Jan 29, 2017
prelude Remove unnecessary CPP in custom Prelude. Sep 3, 2016
src/Text Allow em for image height/width in HTML, LaTeX. May 25, 2017
test Allow em for image height/width in HTML, LaTeX. May 25, 2017
tools Makefile: Separate refactor and reformat targets. Mar 4, 2017
trypandoc Add Muse writer (#3489) Mar 10, 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
.stylish-haskell.yaml Added 'make refactor' using hlint, stylish-haskell. Mar 4, 2017
.travis.yml More travis fixes. Mar 20, 2017
BUGS BUGS: Added reference to CONTRIBUTING.md. Apr 15, 2013
CONTRIBUTING.md Fixed typos in CONTRIBUTING.md (#3479) Mar 1, 2017
COPYING.md Download markdown version of the license from GNU and rename to `COPY… Oct 19, 2016
COPYRIGHT COPYRIGHT: list new files not written by John May 13, 2017
INSTALL.md Revert "Revert "Use file-embed instead of hsb2hs to embed data files."" Apr 2, 2017
MANUAL.txt Added `spaced_reference_links` extension. May 25, 2017
Makefile Makefile: fixed filename for windows package download. May 24, 2017
README.md Update dates in copyright notices May 13, 2017
RELEASE-CHECKLIST Update RELEASE_CHECKLIST. Feb 27, 2017
RELEASE-CHECKLIST.md Updated RELEASE-CHECKLIST and markdownified. Jan 25, 2017
Setup.hs Removed unused imports from Setup.hs. Apr 3, 2017
appveyor.yml Revert "appveyor.yml: don't use matrix." May 24, 2017
changelog Updated changelog. Jan 29, 2017
pandoc.cabal Improve SVG image size code. May 20, 2017
pandoc.hs Text.Pandoc.App: Throw errors rather than exiting. Apr 2, 2017
stack.full.yaml Remove https flag. May 7, 2017
stack.pkg.yaml Remove https flag. May 7, 2017
stack.yaml Remove https flag. May 7, 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, Muse, 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-2017 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.)