- Notifications
You must be signed in to change notification settings - Fork3.5k
jgm/pandoc
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Pandoc is aHaskell library for converting fromone markup format to another, and a command-line tool that uses thislibrary.
It can convertfrom
bibtex(BibTeX bibliography)biblatex(BibLaTeX bibliography)bits(BITS XML, aliasforjats)commonmark(CommonMark Markdown)commonmark_x(CommonMark Markdown withextensions)creole(Creole 1.0)csljson(CSLJSONbibliography)csv(CSV table)tsv(TSVtable)djot(Djot markup)docbook(DocBook)docx(Word docx)dokuwiki(DokuWiki markup)endnotexml(EndNote XMLbibliography)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(Jira/Confluencewiki 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(roff man)mdoc(mdoc manual pagemarkup)muse(Muse)native(native Haskell)odt(OpenDocument textdocument)opml(OPML)org(Emacs Org mode)pod(Perl’sPlain OldDocumentation)ris(RISbibliography)rtf(Rich TextFormat)rst(reStructuredText)t2t(txt2tags)textile(Textile)tikiwiki(TikiWikimarkup)twiki(TWikimarkup)typst(typst)vimwiki(Vimwiki)- the path of a custom Lua reader, seeCustom readers andwritersbelow
It can convertto
ansi(text withANSI escapecodes, for terminalviewing)asciidoc(modernAsciiDoc as interpreted byAsciiDoctor)asciidoc_legacy(AsciiDoc as interpreted byasciidoc-py).asciidoctor(deprecated synonym forasciidoc)beamer(LaTeX beamer slide show)bibtex(BibTeX bibliography)biblatex(BibLaTeX bibliography)chunkedhtml(zip archive of multiple linked HTML files)commonmark(CommonMark Markdown)commonmark_x(CommonMark Markdown withextensions)context(ConTeXt)csljson(CSLJSONbibliography)djot(Djot markup)docbookordocbook4(DocBook 4)docbook5(DocBook 5)docx(Word docx)dokuwiki(DokuWiki markup)epuborepub3(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)htmlorhtml5(HTML,i.e. HTML5/XHTMLpolyglotmarkup)html4(XHTML 1.0 Transitional)icml(InDesignICML)ipynb(Jupyternotebook)jats_archiving(JATS XML, Archiving andInterchange Tag Set)jats_articleauthoring(JATS XML, ArticleAuthoring Tag Set)jats_publishing(JATS XML, JournalPublishing Tag Set)jats(alias forjats_archiving)jira(Jira/Confluencewiki markup)json(JSON version of native AST)latex(LaTeX)man(roff man)markdown(Pandoc’sMarkdown)markdown_mmd(MultiMarkdown)markdown_phpextra(PHP MarkdownExtra)markdown_strict(original unextendedMarkdown)markua(Markua)mediawiki(MediaWikimarkup)ms(roff ms)muse(Muse)native(native Haskell)odt(OpenDocument textdocument)opml(OPML)opendocument(OpenDocumentXML)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 + JavaScriptslide show)s5(S5 HTML and JavaScriptslide show)tei(TEI Simple)typst(typst)xwiki(XWikimarkup)zimwiki(ZimWikimarkup)- the path of a custom Lua writer, seeCustom readers andwritersbelow
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.
Here’show to install pandoc.
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.
Pull requests, bug reports, and feature requests are welcome. Pleasemake sure to readthe contributor guidelines beforeopening a new issue.
© 2006-2024 John MacFarlane (jgm@berkeley.edu). Released under theGPL,version 2 or greater. This software carries no warranty of any kind.(See COPYRIGHT for full copyright and warranty notices.)
About
Universal markup converter