pandoc README

The project's README from github.com/jgm/pandoc. As one markdown file: README.md.

Pandoc

github
release hackage
release homebrew stackage LTS
package CI
tests 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, a limited online demo, and a WebAssembly-based 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-2024 John MacFarlane ([email protected]). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)

pandoc (jgm/pandoc)

haskell
Searching Database…

46.6K ·GitHub
What is this?Pandoc is a Haskell library for converting documents from one markup format to another, plus the command-line tool built on top of it — a universal markup converter.
Is it a command-line tool or a library I code against?Both. It ships as a command-line tool for direct conversions and as a Haskell library you can build into your own programs.
Is installing it straightforward?Yes — the README just points to the pandoc website for installation, where you pick an installer for your OS; after that you run pandoc from the terminal.
Can I expect a conversion to be perfect every time?No. Pandoc preserves a document structure but not formatting details such as margin sizes, and converting from formats more expressive than its Markdown can be lossy.
Can I try it in the browser without installing anything?Yes — the pandoc website hosts a WebAssembly-based online demo (next to a limited classic one), so you can run conversions right in the browser.
Just how many formats are we talking?About 50 input formats — including Word docx, LaTeX, EPUB, Jupyter notebooks, MediaWiki and even Excel spreadsheets — and an even longer output list, with PDF produced via LaTeX, Groff ms, or HTML.
What does Pandoc Markdown add over plain Markdown?Its enhanced Markdown includes syntax for tables, definition lists, metadata blocks, footnotes, citations, math, and much more.
How does one tool manage to support all those formats?Modular design: readers parse each input into an internal abstract syntax tree and writers render that tree into the target format, so a new format needs just one reader or writer.
Can I change what happens between reading and writing?Yes — you can run custom pandoc filters, including Lua filters, that modify the intermediate AST before the output format is produced.
Creator
jgm
Size
71.8 MB
Stars
46.6K
Age
16y
Commits · 90 Days