6license-file: COPYING.md
7copyright: (c) 2006-2018 John MacFarlane
8author: John MacFarlane <jgm@berkeley.edu>
9maintainer: John MacFarlane <jgm@berkeley.edu>
10bug-reports: https://github.com/jgm/pandoc/issues
12homepage: https://pandoc.org
14tested-with: GHC == 7.10.3, GHC == 8.0.2, GHC == 8.2.2, GHC == 8.4.3,
16synopsis: Conversion between markup formats
17description: Pandoc is a Haskell library for converting from one markup
18 format to another, and a command-line tool that uses
19 this library. It can read several dialects of Markdown and
20 (subsets of) HTML, reStructuredText, LaTeX, DocBook, JATS,
21 MediaWiki markup, TWiki markup, TikiWiki markup, Creole 1.0,
22 Haddock markup, OPML, Emacs Org-Mode, Emacs Muse, txt2tags,
23 Vimwiki, Word Docx, ODT, EPUB, FictionBook2, roff man,
24 and Textile, and it can write Markdown, reStructuredText,
25 XHTML, HTML 5, LaTeX, ConTeXt, DocBook, JATS, OPML, TEI,
26 OpenDocument, ODT, Word docx, PowerPoint pptx,
27 RTF, MediaWiki, DokuWiki, ZimWiki, Textile,
28 roff man, roff ms, plain text, Emacs Org-Mode,
29 AsciiDoc, Haddock markup, EPUB (v2 and v3),
30 FictionBook2, InDesign ICML, Muse, LaTeX beamer slides,
31 and several kinds of HTML/JavaScript slide shows
32 (S5, Slidy, Slideous, DZSlides, reveal.js).
34 In contrast to most existing tools for converting Markdown
35 to HTML, pandoc has a modular design: it consists of a set of
36 readers, which parse text in a given format and produce a
37 native representation of the document, and a set of writers,
38 which convert this native representation into a target
39 format. Thus, adding an input or output format requires
40 only adding a reader or writer.
43 data/templates/default.html4
44 data/templates/default.html5
45 data/templates/default.docbook4
46 data/templates/default.docbook5
47 data/templates/default.jats
48 data/templates/default.tei
49 data/templates/default.opendocument
50 data/templates/default.icml
51 data/templates/default.opml
52 data/templates/default.latex
53 data/templates/default.context
54 data/templates/default.texinfo
55 data/templates/default.man
56 data/templates/default.ms
57 data/templates/default.markdown
58 data/templates/default.muse
59 data/templates/default.commonmark
60 data/templates/default.rst
61 data/templates/default.plain
62 data/templates/default.mediawiki
63 data/templates/default.dokuwiki
64 data/templates/default.zimwiki
65 data/templates/default.rtf
66 data/templates/default.s5
67 data/templates/default.slidy
68 data/templates/default.slideous
69 data/templates/default.revealjs
70 data/templates/default.dzslides
71 data/templates/default.asciidoc
72 data/templates/default.haddock
73 data/templates/default.textile
74 data/templates/default.org
75 data/templates/default.epub2
76 data/templates/default.epub3
78 data/translations/*.yaml
79 -- source files for reference.docx
80 data/docx/[Content_Types].xml
82 data/docx/docProps/app.xml
83 data/docx/docProps/core.xml
84 data/docx/docProps/custom.xml
85 data/docx/word/document.xml
86 data/docx/word/fontTable.xml
87 data/docx/word/comments.xml
88 data/docx/word/footnotes.xml
89 data/docx/word/numbering.xml
90 data/docx/word/settings.xml
91 data/docx/word/webSettings.xml
92 data/docx/word/styles.xml
93 data/docx/word/_rels/document.xml.rels
94 data/docx/word/_rels/footnotes.xml.rels
95 data/docx/word/theme/theme1.xml
96 -- source files for reference.odt
102 data/odt/settings.xml
103 data/odt/Configurations2/accelerator/current.xml
104 data/odt/Thumbnails/thumbnail.png
105 data/odt/META-INF/manifest.xml
106 -- source files for reference.pptx
107 data/pptx/_rels/.rels
108 data/pptx/docProps/app.xml
109 data/pptx/docProps/core.xml
110 data/pptx/ppt/slideLayouts/_rels/slideLayout1.xml.rels
111 data/pptx/ppt/slideLayouts/_rels/slideLayout2.xml.rels
112 data/pptx/ppt/slideLayouts/_rels/slideLayout3.xml.rels
113 data/pptx/ppt/slideLayouts/_rels/slideLayout4.xml.rels
114 data/pptx/ppt/slideLayouts/_rels/slideLayout5.xml.rels
115 data/pptx/ppt/slideLayouts/_rels/slideLayout6.xml.rels
116 data/pptx/ppt/slideLayouts/_rels/slideLayout7.xml.rels
117 data/pptx/ppt/slideLayouts/_rels/slideLayout8.xml.rels
118 data/pptx/ppt/slideLayouts/_rels/slideLayout9.xml.rels
119 data/pptx/ppt/slideLayouts/_rels/slideLayout10.xml.rels
120 data/pptx/ppt/slideLayouts/_rels/slideLayout11.xml.rels
121 data/pptx/ppt/slideLayouts/slideLayout1.xml
122 data/pptx/ppt/slideLayouts/slideLayout2.xml
123 data/pptx/ppt/slideLayouts/slideLayout3.xml
124 data/pptx/ppt/slideLayouts/slideLayout4.xml
125 data/pptx/ppt/slideLayouts/slideLayout5.xml
126 data/pptx/ppt/slideLayouts/slideLayout6.xml
127 data/pptx/ppt/slideLayouts/slideLayout7.xml
128 data/pptx/ppt/slideLayouts/slideLayout8.xml
129 data/pptx/ppt/slideLayouts/slideLayout9.xml
130 data/pptx/ppt/slideLayouts/slideLayout10.xml
131 data/pptx/ppt/slideLayouts/slideLayout11.xml
132 data/pptx/ppt/_rels/presentation.xml.rels
133 data/pptx/ppt/theme/theme1.xml
134 data/pptx/ppt/presProps.xml
135 data/pptx/ppt/slides/_rels/slide1.xml.rels
136 data/pptx/ppt/slides/_rels/slide2.xml.rels
137 data/pptx/ppt/slides/slide2.xml
138 data/pptx/ppt/slides/slide1.xml
139 data/pptx/ppt/viewProps.xml
140 data/pptx/ppt/tableStyles.xml
141 data/pptx/ppt/slideMasters/_rels/slideMaster1.xml.rels
142 data/pptx/ppt/slideMasters/slideMaster1.xml
143 data/pptx/ppt/presentation.xml
144 data/pptx/ppt/notesMasters/_rels/notesMaster1.xml.rels
145 data/pptx/ppt/notesMasters/notesMaster1.xml
146 data/pptx/ppt/notesSlides/_rels/notesSlide1.xml.rels
147 data/pptx/ppt/notesSlides/notesSlide1.xml
148 data/pptx/ppt/notesSlides/_rels/notesSlide2.xml.rels
149 data/pptx/ppt/notesSlides/notesSlide2.xml
150 data/pptx/ppt/theme/theme2.xml
151 data/pptx/[Content_Types].xml
152 -- stylesheet for EPUB writer
154 -- data for dzslides writer
155 data/dzslides/template.html
156 -- default abbreviations file
158 -- sample lua custom writer
166 -- bash completion template
167 data/bash_completion.tpl
171 MANUAL.txt, COPYRIGHT
174 INSTALL.md, AUTHORS.md, README.md,
175 CONTRIBUTING.md, BUGS, changelog,
179 -- files needed to build man page
181 man/pandoc.1.template
189 test/command/3533-rst-csv-tables.csv
190 test/command/3880.txt
192 test/command/SVG_logo-without-xml-declaration.svg
193 test/command/SVG_logo.svg
194 test/command/corrupt.svg
195 test/command/inkscape-cube.svg
196 test/command/lua-pandoc-state.lua
197 test/command/sub-file-chapter-1.tex
198 test/command/sub-file-chapter-2.tex
200 test/command/yaml-metadata.yaml
201 test/command/3510-subdoc.org
202 test/command/3510-export.latex
203 test/command/3510-src.hs
204 test/command/3971b.tex
205 test/docbook-reader.docbook
206 test/docbook-xref.docbook
207 test/html-reader.html
208 test/opml-reader.opml
209 test/haddock-reader.haddock
217 test/latex-reader.latex
218 test/textile-reader.textile
219 test/markdown-reader-more.txt
220 test/markdown-citations.txt
221 test/textile-reader.textile
222 test/mediawiki-reader.wiki
223 test/vimwiki-reader.wiki
224 test/creole-reader.txt
225 test/creole-reader.native
230 test/s5-fragment.html
246 test/tables.mediawiki
249 test/tables.opendocument
272 test/writer.mediawiki
274 test/writer.opendocument
289 test/writers-lang-and-dir.latex
290 test/writers-lang-and-dir.context
291 test/dokuwiki_inline_formatting.dokuwiki
292 test/lhs-test.markdown
293 test/lhs-test.markdown+lhs
295 test/lhs-test.rst+lhs
297 test/lhs-test.latex+lhs
299 test/lhs-test.html+lhs
300 test/lhs-test.fragment.html+lhs
302 test/dokuwiki_external_images.dokuwiki
303 test/dokuwiki_external_images.native
304 test/dokuwiki_multiblock_table.dokuwiki
305 test/dokuwiki_multiblock_table.native
308 test/fb2/images-embedded.html
309 test/fb2/images-embedded.fb2
310 test/fb2/test-small.png
311 test/fb2/reader/*.fb2
312 test/fb2/reader/*.native
315 test/docx/golden/*.docx
322 test/twiki-reader.twiki
323 test/tikiwiki-reader.tikiwiki
325 test/odt/markdown/*.md
326 test/odt/native/*.native
328source-repository head
330 location: git://github.com/jgm/pandoc.git
333 Description: Use static linking for pandoc executable.
337 Description: Embed data files in binary for relocatable executable.
341 Description: Build trypandoc cgi executable.
345 setup-depends: base, Cabal >= 2.0
348 build-depends: base >= 4.8 && < 5,
350 containers >= 0.4.2.1 && < 0.7,
351 unordered-containers >= 0.2 && < 0.3,
352 parsec >= 3.1 && < 3.2,
354 exceptions >= 0.8 && < 0.11,
355 filepath >= 1.1 && < 1.5,
356 process >= 1.2.3 && < 1.7,
357 directory >= 1 && < 1.4,
358 bytestring >= 0.9 && < 0.11,
359 text >= 0.11 && < 1.3,
360 time >= 1.5 && < 1.10,
361 safe >= 0.3 && < 0.4,
362 zip-archive >= 0.2.3.4 && < 0.4,
363 HTTP >= 4000.0.5 && < 4000.4,
364 texmath >= 0.11 && < 0.12,
365 xml >= 1.3.12 && < 1.4,
366 split >= 0.2 && < 0.3,
367 random >= 1 && < 1.2,
368 pandoc-types >= 1.17.5 && < 1.18,
369 aeson >= 0.7 && < 1.5,
370 aeson-pretty >= 0.8.5 && < 0.9,
371 tagsoup >= 0.14.6 && < 0.15,
372 base64-bytestring >= 0.1 && < 1.1,
373 zlib >= 0.5 && < 0.7,
374 skylighting >= 0.7.4 && < 0.8,
375 data-default >= 0.4 && < 0.8,
376 temporary >= 1.1 && < 1.4,
377 blaze-html >= 0.9 && < 0.10,
378 blaze-markup >= 0.8 && < 0.9,
379 vector >= 0.10 && < 0.13,
380 hslua >= 1.0.1 && < 1.1,
381 hslua-module-text >= 0.2 && < 0.3,
382 binary >= 0.5 && < 0.11,
384 haddock-library >= 1.7 && < 1.8,
385 deepseq >= 1.3 && < 1.5,
386 JuicyPixels >= 3.1.6.1 && < 3.4,
387 Glob >= 0.7 && < 0.10,
388 cmark-gfm >= 0.1.1 && < 0.2,
389 doctemplates >= 0.2.1 && < 0.3,
390 network-uri >= 2.6 && < 2.7,
392 http-client >= 0.4.30 && < 0.6,
393 http-client-tls >= 0.2.4 && < 0.4,
394 http-types >= 0.8 && < 0.13,
395 case-insensitive >= 1.2 && < 1.3,
396 unicode-transforms >= 0.3 && < 0.4,
397 HsYAML >= 0.1.1.1 && < 0.2
399 build-depends: semigroups == 0.18.*,
400 -- basement 0.0.8 and foundation 0.0.21, transitive
401 -- dependencies, drop support for ghc 7.10:
405 hs-source-dirs: prelude
406 other-modules: Prelude
407 build-depends: base-compat >= 0.9
409 cpp-options: -D_WINDOWS
411 build-depends: unix >= 2.4 && < 2.8
412 if flag(embed_data_files)
413 cpp-options: -DEMBED_DATA_FILES
414 build-depends: file-embed >= 0.0 && < 0.1
415 other-modules: Text.Pandoc.Data
417 cpp-options: -D_WINDOWS
418 ghc-options: -Wall -fno-warn-unused-do-bind
420 ghc-options: -Wincomplete-record-updates
421 -Wnoncanonical-monad-instances
422 -Wnoncanonical-monadfail-instances
424 ghc-options: -Wincomplete-uni-patterns
426 -Werror=missing-home-modules
427 default-language: Haskell2010
428 other-extensions: NoImplicitPrelude
431 exposed-modules: Text.Pandoc,
434 Text.Pandoc.Extensions,
437 Text.Pandoc.MediaBag,
441 Text.Pandoc.Readers.HTML,
442 Text.Pandoc.Readers.LaTeX,
443 Text.Pandoc.Readers.LaTeX.Types,
444 Text.Pandoc.Readers.Markdown,
445 Text.Pandoc.Readers.CommonMark,
446 Text.Pandoc.Readers.Creole,
447 Text.Pandoc.Readers.MediaWiki,
448 Text.Pandoc.Readers.Vimwiki,
449 Text.Pandoc.Readers.RST,
450 Text.Pandoc.Readers.Org,
451 Text.Pandoc.Readers.DocBook,
452 Text.Pandoc.Readers.JATS,
453 Text.Pandoc.Readers.OPML,
454 Text.Pandoc.Readers.Textile,
455 Text.Pandoc.Readers.Native,
456 Text.Pandoc.Readers.Haddock,
457 Text.Pandoc.Readers.TWiki,
458 Text.Pandoc.Readers.TikiWiki,
459 Text.Pandoc.Readers.Txt2Tags,
460 Text.Pandoc.Readers.Docx,
461 Text.Pandoc.Readers.Odt,
462 Text.Pandoc.Readers.EPUB,
463 Text.Pandoc.Readers.Muse,
464 Text.Pandoc.Readers.Man,
465 Text.Pandoc.Readers.FB2,
467 Text.Pandoc.Writers.Native,
468 Text.Pandoc.Writers.Docbook,
469 Text.Pandoc.Writers.JATS,
470 Text.Pandoc.Writers.OPML,
471 Text.Pandoc.Writers.HTML,
472 Text.Pandoc.Writers.ICML,
473 Text.Pandoc.Writers.LaTeX,
474 Text.Pandoc.Writers.ConTeXt,
475 Text.Pandoc.Writers.OpenDocument,
476 Text.Pandoc.Writers.Texinfo,
477 Text.Pandoc.Writers.Man,
478 Text.Pandoc.Writers.Ms,
479 Text.Pandoc.Writers.Markdown,
480 Text.Pandoc.Writers.CommonMark,
481 Text.Pandoc.Writers.Haddock,
482 Text.Pandoc.Writers.RST,
483 Text.Pandoc.Writers.Org,
484 Text.Pandoc.Writers.AsciiDoc,
485 Text.Pandoc.Writers.Custom,
486 Text.Pandoc.Writers.Textile,
487 Text.Pandoc.Writers.MediaWiki,
488 Text.Pandoc.Writers.DokuWiki,
489 Text.Pandoc.Writers.ZimWiki,
490 Text.Pandoc.Writers.RTF,
491 Text.Pandoc.Writers.ODT,
492 Text.Pandoc.Writers.Docx,
493 Text.Pandoc.Writers.Powerpoint,
494 Text.Pandoc.Writers.EPUB,
495 Text.Pandoc.Writers.FB2,
496 Text.Pandoc.Writers.TEI,
497 Text.Pandoc.Writers.Muse,
498 Text.Pandoc.Writers.Math,
499 Text.Pandoc.Writers.Shared,
500 Text.Pandoc.Writers.OOXML,
504 Text.Pandoc.Templates,
506 Text.Pandoc.SelfContained,
507 Text.Pandoc.Highlighting,
514 Text.Pandoc.ImageSize,
517 other-modules: Text.Pandoc.App.CommandLineOptions,
518 Text.Pandoc.App.OutputSettings,
519 Text.Pandoc.Filter.JSON,
520 Text.Pandoc.Filter.Lua,
521 Text.Pandoc.Filter.Path,
522 Text.Pandoc.Readers.Docx.Lists,
523 Text.Pandoc.Readers.Docx.Combine,
524 Text.Pandoc.Readers.Docx.Parse,
525 Text.Pandoc.Readers.Docx.Util,
526 Text.Pandoc.Readers.Docx.StyleMap,
527 Text.Pandoc.Readers.Docx.Fields,
528 Text.Pandoc.Readers.LaTeX.Parsing,
529 Text.Pandoc.Readers.LaTeX.Lang,
530 Text.Pandoc.Readers.Odt.Base,
531 Text.Pandoc.Readers.Odt.Namespaces,
532 Text.Pandoc.Readers.Odt.StyleReader,
533 Text.Pandoc.Readers.Odt.ContentReader,
534 Text.Pandoc.Readers.Odt.Generic.Fallible,
535 Text.Pandoc.Readers.Odt.Generic.SetMap,
536 Text.Pandoc.Readers.Odt.Generic.Utils,
537 Text.Pandoc.Readers.Odt.Generic.Namespaces,
538 Text.Pandoc.Readers.Odt.Generic.XMLConverter,
539 Text.Pandoc.Readers.Odt.Arrows.State,
540 Text.Pandoc.Readers.Odt.Arrows.Utils,
541 Text.Pandoc.Readers.Org.BlockStarts,
542 Text.Pandoc.Readers.Org.Blocks,
543 Text.Pandoc.Readers.Org.DocumentTree,
544 Text.Pandoc.Readers.Org.ExportSettings,
545 Text.Pandoc.Readers.Org.Inlines,
546 Text.Pandoc.Readers.Org.Meta,
547 Text.Pandoc.Readers.Org.ParserState,
548 Text.Pandoc.Readers.Org.Parsing,
549 Text.Pandoc.Readers.Org.Shared,
550 Text.Pandoc.Readers.Roff,
551 Text.Pandoc.Writers.Roff,
552 Text.Pandoc.Writers.Powerpoint.Presentation,
553 Text.Pandoc.Writers.Powerpoint.Output,
554 Text.Pandoc.Lua.Filter,
555 Text.Pandoc.Lua.Global,
556 Text.Pandoc.Lua.Init,
557 Text.Pandoc.Lua.Module.MediaBag,
558 Text.Pandoc.Lua.Module.Pandoc,
559 Text.Pandoc.Lua.Module.Utils,
560 Text.Pandoc.Lua.Packages,
561 Text.Pandoc.Lua.StackInstances,
562 Text.Pandoc.Lua.Util,
565 Text.Pandoc.RoffChar,
567 Text.Pandoc.Translations,
570 autogen-modules: Paths_pandoc
574 build-depends: pandoc, base >= 4.8 && < 5
576 build-depends: semigroups == 0.18.*
578 hs-source-dirs: prelude
579 other-modules: Prelude
580 build-depends: base-compat >= 0.9
581 ghc-options: -rtsopts -with-rtsopts=-K16m -Wall -fno-warn-unused-do-bind -threaded
584 default-language: Haskell2010
585 other-extensions: NoImplicitPrelude
589 other-modules: Paths_pandoc
592 main-is: trypandoc.hs
593 hs-source-dirs: trypandoc
594 default-language: Haskell2010
595 other-extensions: NoImplicitPrelude
597 build-depends: base, aeson, pandoc,
598 text, wai-extra, wai >= 0.3, http-types
603 build-depends: semigroups == 0.18.*
605 hs-source-dirs: prelude
606 other-modules: Prelude
607 build-depends: base-compat >= 0.9
609benchmark weigh-pandoc
610 type: exitcode-stdio-1.0
611 main-is: weigh-pandoc.hs
612 hs-source-dirs: benchmark
613 build-depends: pandoc,
616 weigh >= 0.0 && < 0.1,
619 build-depends: semigroups == 0.18.*
621 hs-source-dirs: prelude
622 other-modules: Prelude
623 build-depends: base-compat >= 0.9
624 ghc-options: -rtsopts -Wall -fno-warn-unused-do-bind -threaded
625 default-language: Haskell2010
626 other-extensions: NoImplicitPrelude
628test-suite test-pandoc
629 type: exitcode-stdio-1.0
630 main-is: test-pandoc.hs
632 build-depends: base >= 4.8 && < 5,
634 pandoc-types >= 1.17.5 && < 1.18,
635 bytestring >= 0.9 && < 0.11,
636 base64-bytestring >= 0.1 && < 1.1,
637 text >= 0.11 && < 1.3,
638 time >= 1.5 && < 1.10,
639 directory >= 1 && < 1.4,
640 filepath >= 1.1 && < 1.5,
641 hslua >= 1.0 && < 1.1,
642 process >= 1.2.3 && < 1.7,
643 temporary >= 1.1 && < 1.4,
644 Diff >= 0.2 && < 0.4,
645 tasty >= 0.11 && < 1.2,
646 tasty-hunit >= 0.9 && < 0.11,
647 tasty-quickcheck >= 0.8 && < 0.11,
648 tasty-golden >= 2.3 && < 2.4,
649 QuickCheck >= 2.4 && < 2.13,
650 containers >= 0.4.2.1 && < 0.7,
651 executable-path >= 0.0 && < 0.1,
652 zip-archive >= 0.2.3.4 && < 0.4,
653 xml >= 1.3.12 && < 1.4,
654 Glob >= 0.7 && < 0.10
656 build-depends: semigroups == 0.18.*
658 hs-source-dirs: prelude
659 other-modules: Prelude
660 build-depends: base-compat >= 0.9
661 other-modules: Tests.Old
669 Tests.Readers.Markdown
671 Tests.Readers.Org.Block
672 Tests.Readers.Org.Block.CodeBlock
673 Tests.Readers.Org.Block.Figure
674 Tests.Readers.Org.Block.Header
675 Tests.Readers.Org.Block.List
676 Tests.Readers.Org.Block.Table
677 Tests.Readers.Org.Directive
678 Tests.Readers.Org.Inline
679 Tests.Readers.Org.Inline.Citation
680 Tests.Readers.Org.Inline.Note
681 Tests.Readers.Org.Inline.Smart
682 Tests.Readers.Org.Meta
683 Tests.Readers.Org.Shared
687 Tests.Readers.Txt2Tags
694 Tests.Writers.ConTeXt
695 Tests.Writers.Docbook
698 Tests.Writers.Markdown
701 Tests.Writers.AsciiDoc
708 Tests.Writers.Powerpoint
710 ghc-options: -rtsopts -Wall -fno-warn-unused-do-bind -threaded
711 default-language: Haskell2010
712 other-extensions: NoImplicitPrelude
714benchmark benchmark-pandoc
715 type: exitcode-stdio-1.0
716 main-is: benchmark-pandoc.hs
717 hs-source-dirs: benchmark
718 build-depends: pandoc,
719 time, bytestring, containers,
721 text >= 0.11 && < 1.3,
723 criterion >= 1.0 && < 1.6
725 build-depends: semigroups == 0.18.*
727 hs-source-dirs: prelude
728 other-modules: Prelude
729 build-depends: base-compat >= 0.9
730 ghc-options: -rtsopts -Wall -fno-warn-unused-do-bind -threaded
731 default-language: Haskell2010
732 other-extensions: NoImplicitPrelude
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list