pandoc:Conversion between markup formats

[gpl,library,text ] [Propose Tags ] [Report a vulnerability ]

Pandoc is a Haskell library for converting from one markupformat to another, and a command-line tool that usesthis library. It can read several dialects of Markdown and(subsets of) HTML, reStructuredText, LaTeX, DocBook, JATS,MediaWiki markup, DokuWiki markup, TWiki markup,TikiWiki markup, Jira markup, Creole 1.0, Haddock markup,OPML, Emacs Org-Mode, Emacs Muse, txt2tags, ipynb (Jupyternotebooks), Vimwiki, Word Docx, ODT, EPUB, FictionBook2,roff man, and Textile, and it can write Markdown,reStructuredText, XHTML, HTML 5, LaTeX, ConTeXt, DocBook,JATS, OPML, TEI, OpenDocument, ODT, Word docx,PowerPoint pptx, RTF, MediaWiki, DokuWiki, XWiki,ZimWiki, Textile, Jira, roff man, roff ms, plain text,Emacs Org-Mode, AsciiDoc, Haddock markup,EPUB (v2 and v3), ipynb, FictionBook2,InDesign ICML, Muse, LaTeX beamer slides,and several kinds of HTML/JavaScript slide shows(S5, Slidy, Slideous, DZSlides, reveal.js).

In contrast to most existing tools for converting Markdownto HTML, pandoc has a modular design: it consists of a set ofreaders, which parse text in a given format and produce anative representation of the document, and a set of writers,which convert this native representation into a targetformat. Thus, adding an input or output format requiresonly adding a reader or writer.

[Skip to Readme]

Modules

[Index] [Quick Jump]

Text
- Text.Pandoc

Flags

Automatic Flags

Name	Description	Default
static	Use static linking for pandoc executable.	Disabled
embed_data_files	Embed data files in binary for relocatable executable.	Disabled
trypandoc	Build trypandoc cgi executable.	Disabled

Use-f <flag> to enable a flag, or-f -<flag> to disable that flag.More info

Downloads

pandoc-2.9.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

JohnMacFarlane

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions[RSS]	0.4,0.41,0.42,0.43,0.44,0.45,0.46,1.0,1.0.0.1,1.1,1.2,1.2.1,1.3,1.4,1.5,1.5.0.1,1.5.1,1.5.1.1,1.6,1.6.0.1,1.8,1.8.0.1,1.8.0.2,1.8.0.3,1.8.1,1.8.1.1,1.8.1.2,1.8.2,1.8.2.1,1.9,1.9.0.2,1.9.0.3,1.9.0.4,1.9.0.5,1.9.1,1.9.1.1,1.9.1.2,1.9.2,1.9.3,1.9.4,1.9.4.1,1.9.4.2,1.9.4.3,1.9.4.4,1.9.4.5,1.10,1.10.0.1,1.10.0.2,1.10.0.3,1.10.0.4,1.10.0.5,1.10.1,1.11,1.11.1,1.12,1.12.0.1,1.12.0.2,1.12.1,1.12.2,1.12.2.1,1.12.3,1.12.3.1,1.12.3.2,1.12.3.3,1.12.4,1.12.4.2,1.13,1.13.0.1,1.13.1,1.13.2,1.13.2.1,1.14,1.14.0.1,1.14.0.2,1.14.0.3,1.14.0.4,1.14.1,1.15,1.15.0.1,1.15.0.2,1.15.0.3,1.15.0.4,1.15.0.5,1.15.0.6,1.15.1,1.15.1.1,1.15.2,1.15.2.1,1.16,1.16.0.1,1.16.0.2,1.17,1.17.0.1,1.17.0.2,1.17.0.3,1.17.1,1.17.2,1.18,1.19,1.19.1,1.19.2,1.19.2.1,1.19.2.2,1.19.2.3,1.19.2.4,2.0,2.0.0.1,2.0.1,2.0.1.1,2.0.2,2.0.3,2.0.4,2.0.5,2.0.6,2.1,2.1.1,2.1.2,2.1.3,2.2,2.2.1,2.2.2,2.2.2.1,2.2.3,2.2.3.1,2.2.3.2,2.3,2.3.1,2.4,2.5,2.6,2.7,2.7.1,2.7.2,2.7.3,2.8,2.8.0.1,2.8.1,2.9,2.9.1,2.9.1.1,2.9.2,2.9.2.1,2.10,2.10.1,2.11,2.11.0.1,2.11.0.2,2.11.0.3,2.11.0.4,2.11.1,2.11.1.1,2.11.2,2.11.3,2.11.3.1,2.11.3.2,2.11.4,2.12,2.13,2.14,2.14.0.1,2.14.0.2,2.14.0.3,2.14.1,2.14.2,2.15,2.16,2.16.1,2.16.2,2.17,2.17.0.1,2.17.1,2.17.1.1,2.18,2.19,2.19.1,2.19.2,3.0,3.0.1,3.1,3.1.1,3.1.2,3.1.3,3.1.4,3.1.5,3.1.6,3.1.6.1,3.1.6.2,3.1.7,3.1.8,3.1.9,3.1.10,3.1.11,3.1.11.1,3.1.12,3.1.12.1,3.1.12.2,3.1.12.3,3.1.13,3.2,3.2.1,3.3,3.4,3.5,3.6,3.6.1,3.6.2,3.6.3,3.6.4 (info)
Change log	changelog.md
Dependencies	aeson (>=0.7 && <1.5),aeson-pretty (>=0.8.5 && <0.9),attoparsec (>=0.12 && <0.14),base (>=4.9 && <5),base-compat (>=0.9),base64-bytestring (>=0.1 && <1.1),basement (>=0.0.10),binary (>=0.5 && <0.11),blaze-html (>=0.9 && <0.10),blaze-markup (>=0.8 && <0.9),bytestring (>=0.9 && <0.11),case-insensitive (>=1.2 && <1.3),cmark-gfm (>=0.2 && <0.3),containers (>=0.4.2.1 && <0.7),data-default (>=0.4 && <0.8),deepseq (>=1.3 && <1.5),directory (>=1.2.3 && <1.4),doclayout (>=0.2.0.1 && <0.3),doctemplates (>=0.8 && <0.9),emojis (>=0.1 && <0.2),exceptions (>=0.8 && <0.11),file-embed (>=0.0 && <0.1),filepath (>=1.1 && <1.5),foundation (>=0.0.23),Glob (>=0.7 && <0.11),haddock-library (>=1.8 && <1.9),hslua (>=1.0.1 && <1.1),hslua-module-system (>=0.2 && <0.3),hslua-module-text (>=0.2 && <0.3),HsYAML (>=0.2 && <0.3),HTTP (>=4000.0.5 && <4000.4),http-client (>=0.4.30 && <0.7),http-client-tls (>=0.2.4 && <0.4),http-types (>=0.8 && <0.13),ipynb (>=0.1 && <0.2),jira-wiki-markup (>=1.0 && <1.1),JuicyPixels (>=3.1.6.1 && <3.4),mtl (>=2.2 && <2.3),network (>=2.6),network-uri (>=2.6 && <2.7),pandoc,pandoc-types (>=1.20 && <1.21),parsec (>=3.1 && <3.2),process (>=1.2.3 && <1.7),random (>=1 && <1.2),safe (>=0.3 && <0.4),scientific (>=0.3 && <0.4),SHA (>=1.6 && <1.7),skylighting (>=0.8.3 && <0.9),skylighting-core (>=0.8.3 && <0.9),split (>=0.2 && <0.3),syb (>=0.1 && <0.8),tagsoup (>=0.14.6 && <0.15),temporary (>=1.1 && <1.4),texmath (>=0.12 && <0.13),text (>=1.1.1.0 && <1.3),text-conversions (>=0.3 && <0.4),time (>=1.5 && <1.10),unicode-transforms (>=0.3 && <0.4),unix (>=2.4 && <2.8),unordered-containers (>=0.2 && <0.3),vector (>=0.10 && <0.13),wai (>=0.3),wai-extra,xml (>=1.3.12 && <1.4),zip-archive (>=0.2.3.4 && <0.5),zlib (>=0.5 && <0.7) [details]
Tested with	ghc ==8.0.2, ghc ==8.2.2, ghc ==8.4.4, ghc ==8.6.5
License	GPL-2.0-only
Copyright	(c) 2006-2019 John MacFarlane
Author	John MacFarlane <jgm@berkeley.edu>
Maintainer	John MacFarlane <jgm@berkeley.edu>
Category	Text
Home page	https://pandoc.org
Bug tracker	https://github.com/jgm/pandoc/issues
Source repo	head: git clonegit://github.com/jgm/pandoc.git
Uploaded	byJohnMacFarlane at2019-12-23T15:44:59Z
Distributions	Arch:3.1.12.1, Debian:2.9.2.1, Fedora:3.1.3, FreeBSD:1.15.0.6, LTSHaskell:3.6, NixOS:3.1.11.1, Stackage:3.6.4, openSUSE:3.6.4
Reverse Dependencies	92 direct, 77 indirect [details]
Executables	trypandoc, pandoc
Downloads	361685 total (969 in the last 30 days)
Rating	3.0 (votes: 24)[estimated byBayesian average]
Your Rating	λ λ λ
Status	Docs available[build log] Last success reported on 2019-12-23[all 1 reports]

Readme for pandoc-2.9.1

[back to package description]

Pandoc

The universal markup converter

Pandoc is aHaskell library for converting fromone markup format to another, and a command-line tool that uses thislibrary. It can convertfrom

commonmark (CommonMark Markdown)
creole (Creole 1.0)
docbook (DocBook)
docx (Word docx)
dokuwiki (DokuWiki markup)
epub (EPUB)
fb2(FictionBook2e-book)
gfm (GitHub-FlavoredMarkdown),or the deprecated and less accuratemarkdown_github; usemarkdown_githubonly if you need extensions not supported ingfm.
haddock (Haddockmarkup)
html (HTML)
ipynb (Jupyternotebook)
jats (JATS XML)
jira(Jirawiki markup)
json (JSON version of native AST)
latex (LaTeX)
markdown (Pandoc’sMarkdown)
markdown_mmd(MultiMarkdown)
markdown_phpextra (PHP MarkdownExtra)
markdown_strict (original unextendedMarkdown)
mediawiki (MediaWikimarkup)
man (roffman)
muse (Muse)
native (native Haskell)
odt (ODT)
opml (OPML)
org (Emacs Org mode)
rst(reStructuredText)
t2t (txt2tags)
textile (Textile)
tikiwiki (TikiWikimarkup)
twiki (TWikimarkup)
vimwiki (Vimwiki)

It can convertto

asciidoc (AsciiDoc) orasciidoctor (AsciiDoctor)
beamer (LaTeX beamer slide show)
commonmark (CommonMark Markdown)
context (ConTeXt)
docbook ordocbook4 (DocBook 4)
docbook5 (DocBook 5)
docx (Word docx)
dokuwiki (DokuWiki markup)
epub orepub3 (EPUB v3 book)
epub2 (EPUB v2)
fb2(FictionBook2e-book)
gfm (GitHub-FlavoredMarkdown),or the deprecated and less accuratemarkdown_github; usemarkdown_githubonly if you need extensions not supported ingfm.
haddock (Haddockmarkup)
html orhtml5 (HTML,i.e. HTML5/XHTMLpolyglotmarkup)
html4 (XHTML 1.0 Transitional)
icml (InDesignICML)
ipynb (Jupyternotebook)
jats (JATS XML)
jira(Jirawiki markup)
json (JSON version of native AST)
latex (LaTeX)
man (roffman)
markdown (Pandoc’sMarkdown)
markdown_mmd(MultiMarkdown)
markdown_phpextra (PHP MarkdownExtra)
markdown_strict (original unextendedMarkdown)
mediawiki (MediaWikimarkup)
ms (roffms)
muse (Muse),
native (native Haskell),
odt (OpenOffice textdocument)
opml (OPML)
opendocument (OpenDocument)
org (Emacs Org mode)
pdf (PDF)
plain (plain text),
pptx(PowerPointslide show)
rst(reStructuredText)
rtf (Rich TextFormat)
texinfo (GNU Texinfo)
textile (Textile)
slideous (Slideous HTMLand JavaScript slide show)
slidy (Slidy HTML andJavaScript slide show)
dzslides (DZSlides HTML5 +JavaScript slide show),
revealjs (reveal.js HTML5 +JavaScript slide show)
s5 (S5 HTML and JavaScriptslide show)
tei (TEI Simple)
xwiki (XWikimarkup)
zimwiki (ZimWikimarkup)
the path of a custom lua writer, seeCustomwriters below

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 muchmore. See the User’s Manual below underPandoc’sMarkdown.

Pandoc has a modular design: it consists of a set of readers, whichparse text in a given format and produce a native representation of thedocument (anabstract syntax tree or AST), and a set of writers, whichconvert this native representation into a target format. Thus, adding aninput or output format requires only adding a reader or writer. Userscan also run custom pandoc filters to modify the intermediate AST (seethe documentation forfilters andlua filters).

Because pandoc’s intermediate representation of a document is lessexpressive than many of the formats it converts between, one should notexpect perfect conversions between every format and every other. Pandocattempts to preserve the structural elements of a document, but notformatting details such as margin size. And some document elements, suchas complex tables, may not fit into pandoc’s simple document model.While conversions from pandoc’s Markdown to all formats aspire to beperfect, conversions from formats more expressive than pandoc’s Markdowncan be expected to be lossy.

Installing

Here’show to install pandoc.

Documentation

Pandoc’s website contains a fullUser’sGuide. It is also availablehere as pandoc-flavored Markdown. The website alsocontains someexamples of the use ofpandoc and a limitedonlinedemo.

Contributing

Pull requests, bug reports, and feature requests are welcome. Pleasemake sure to readthe contributor guidelines beforeopening a new issue.

Movatterモバイル変換