git.iko.soy/typeable/pandoc
on 1.0 help sign in
typeable/pandoc/web/index.txt.in
183 lines 7.9 kB history raw
1% Pandoc
3# Overview
5Pandoc is a [Haskell] library for converting from one markup format
6to another, and a command-line tool that uses this library. It can read
7[markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX],
8and it can write [markdown], [reStructuredText], [HTML], [LaTeX], [ConTeXt],
9[PDF], [RTF], [DocBook XML], [OpenDocument XML], [ODT], [GNU Texinfo],
10[MediaWiki markup], [groff man] pages, and [S5] HTML slide shows.
12Pandoc features
14- Modular design, using separate writers and readers for each
15 supported format.
16- A real markdown parser, not based on regex substitutions.
17 [More accurate] and [much faster] than `Markdown.pl`.
18- Also parses (subsets of) reStructuredText, LaTeX, and HTML.
19- Multiple output formats: HTML, Docbook XML, LaTeX, ConTeXt,
20 reStructuredText, Markdown, RTF, groff man pages, OpenDocument
21 XML, ODT (Open Office document), MediaWiki, GNU Texinfo,
22 S5 slide shows.
23- Unicode support.
24- Optional "smart" quotes, dashes, and ellipses.
25- Automatically generated tables of contents.
26- Support for displaying math in HTML.
27- Extensions to markdown syntax:
28 + Document metadata (title, author, date).
29 + Footnotes, tables, and definition lists.
30 + Superscripts, subscripts, and strikeout.
31 + Inline LaTeX math and LaTeX commands.
32 + Markdown inside HTML blocks.
33 + Enhanced ordered lists: start number and numbering style
34 are significant.
35 + Delimited (unindented) code blocks with syntax highlighting.
36 + Compatibility mode to turn off syntax entensions and emulate
37 `Markdown.pl`.
38- Convenient wrapper scripts:
39 + `markdown2pdf` converts directly from markdown to PDF, using
40 `pdflatex`.
41 + `html2markdown` makes it easy to produce a markdown version
42 of any web page.
43 + `hsmarkdown` is a drop-in replacement for `Markdown.pl`.
44- Multi-platform: runs on Windows, MacOS X, Linux, Unix.
45- Free software, released under the [GPL].
47To see what pandoc can do, see the [demonstration page](examples.html),
48or [try pandoc on the web](/pandoc/try).
50# Documentation
52- [User's Guide](README.html)
53- [Demonstrations](examples.html)
54- Man pages
55 - [`pandoc(1)`](pandoc.1.html)
56 - [`markdown2pdf(1)`](markdown2pdf.1.html)
57 - [`html2markdown(1)`](html2markdown.1.html)
58 - [`hsmarkdown(1)`](hsmarkdown.1.html)
59- [Library documentation](doc/pandoc/index.html) (for Haskell programmers)
60- [Installation instructions](INSTALL.html)
61- [Changelog](changelog.txt)
63# Downloads
65For installation instructions for all architectures, see
66[INSTALL](INSTALL.html). Pandoc is in the [MacPorts], [Debian unstable],
67[Ubuntu], and [FreeBSD ports] repositories. Abhishek Dasgupta has also
68contributed an [Arch linux PKGBUILD script]. Note that the version of
69pandoc in these repositories may not be the most recent.
71- [Source tarball]
72- [Windows binary package]
74# Code repository
76Pandoc has a publicly accesible subversion repository at Google
77Code (<http://code.google.com/p/pandoc>). To check out the latest,
78bleeding-edge source code:
80 svn checkout http://pandoc.googlecode.com/svn/trunk/ pandoc
82# Reporting bugs
84You may view existing bug reports and submit new ones at
85<http://code.google.com/p/pandoc/issues/list>.
87# Mailing lists
89- [pandoc-announce]: Announcements of new releases only.
90- [pandoc-discuss]: General discussion of pandoc.
92# News
94- Version 1.0 release (October 11, 2008).
96 + New writers for MediaWiki, GNU Texinfo (thanks to Peter Wang),
97 OpenDocument XML (thanks to Andrea Rossato), and ODT (OpenOffice
98 document).
99 + New [delimited code blocks](README.html#delimited-code-blocks),
100 with optional syntax highlighting.
101 + Reorganized build system: pandoc can now be built using standard
102 Cabal tools. It can be compiled on Windows without Cygwin.
103 The tests can also be run without perl or unix tools.
104 + LaTeXMathML replaces ASCIIMathML for rendering math in HTML.
105 + Support for "displayed" math.
106 + Common abbreviations are now handled more intelligently, with
107 a non-breaking space (and not a sentence-ending space) after
108 the period.
109 + Code is -Wall clean.
110 + Many bug fixes and small improvements. See [changelog] for
111 full details.
113- Version 0.46 released (January 8, 2008).
115 + Added a `--sanitize-html` option (and a corresponding parameter
116 in `ParserState` for those using the pandoc libraries in programs).
117 This option causes pandoc to sanitize HTML (in HTML or Markdown
118 input) using a whitelist method. Possibly harmful HTML elements
119 are replaced with HTML comments. This should be useful in the
120 context of web applications, where pandoc may be used to convert
121 user input into HTML.
122 + Made -H, -A, and -B options cumulative: if they are specified
123 multiple times, multiple files will be included.
124 + Many bug fixes and small improvements. See [changelog] for full
125 details.
127- Version 0.45 released (December 9, 2007).
129 + Many bug fixes and structural improvements. See [changelog] for
130 full details.
131 + Improved treatment of math. Math is now rendered using unicode
132 by default in HTML, RTF, and DocBook output. For more accurate
133 display of math in HTML, `--gladtex`, `--mimetex`, and `--asciimathml`
134 options are provided. See the [User's Guide](README.html#math) for
135 details.
136 + Removed support for box-style block quotes in markdown.
137 + More idiomatic ConTeXt output.
138 + Text wrapping in ConTeXt and LaTeX output.
139 + Pandoc now correctly handles all standard line endings
140 (CR, LF, CRLF).
141 + New `--no-wrap` option that disables line wrapping and minimizes
142 whitespace in HTML output.
143 + Build process is now compatible with both GHC 6.8 and GHC 6.6.
144 GHC and GHC_PKG environment variables may be used to specify
145 which version of the compiler to use, when multiple versions are
146 installed.
148# Disclaimer
150Pandoc carries no warranties of any kind.
152[More accurate]: http://code.google.com/p/pandoc/wiki/PandocVsMarkdownPl
153[much faster]: http://code.google.com/p/pandoc/wiki/Benchmarks
155[John MacFarlane]: http://johnmacfarlane.net/
156[markdown]: http://daringfireball.net/projects/markdown/
157[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
158[S5]: http://meyerweb.com/eric/tools/s5/
159[HTML]: http://www.w3.org/TR/html40/
160[LaTeX]: http://www.latex-project.org/
161[ConTeXt]: http://www.pragma-ade.nl/
162[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
163[PDF]: http://en.wikipedia.org/wiki/Portable_Document_Format
164[ODT]: http://en.wikipedia.org/wiki/OpenDocument
165[DocBook XML]: http://www.docbook.org/
166[OpenDocument XML]: http://opendocument.xml.org/
167[MediaWiki markup]: http://www.mediawiki.org/wiki/Help:Formatting
168[groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html
169[GNU Texinfo]: http://www.gnu.org/software/texinfo/
170[Haskell]: http://www.haskell.org/
171[GHC]: http://www.haskell.org/ghc/
172[GPL]: http://www.gnu.org/copyleft/gpl.html
173[Source tarball]: http://code.google.com/p/pandoc/downloads/detail?name=pandoc-@VERSION@.tar.gz "Download source tarball from Pandoc's Google Code site"
174[Windows binary package]: http://code.google.com/p/pandoc/downloads/detail?name=pandoc-@VERSION@.zip "Download Windows zip file from Pandoc's Google Code site"
175[Debian unstable]: http://packages.debian.org/unstable/text/pandoc
176[FreeBSD ports]: http://www.freshports.org/textproc/pandoc/
177[Arch linux PKGBUILD script]: http://aur.archlinux.org/packages.php?do_Details=1&ID=12751&O=0&L=0&C=0&K=pandoc&SB=n&SO=a&PP=25&do_MyPackages=0&do_Orphans=0&SeB=nd
178[Ubuntu]: http://www.ubuntu.com
179[MacPorts]: http://db.macports.org/port/show/4218
180[pandoc-announce]: http://groups.google.com/group/pandoc-announce
181[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
182[changelog]: changelog.txt