diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 30 |
1 files changed, 17 insertions, 13 deletions
@@ -6,9 +6,9 @@ Pandoc is a [Haskell] library for converting from one markup format to another, and a command-line tool that uses this library. It can read [markdown] and (subsets of) [reStructuredText], [HTML], and [LaTeX], and it can write [markdown], [reStructuredText], [HTML], [LaTeX], [ConTeXt], -[RTF], [DocBook XML], [groff man] pages, and [S5] HTML slide shows. -Pandoc's version of markdown contains some enhancements, like footnotes -and embedded LaTeX. +[RTF], [DocBook XML], [GNU Texinfo], [groff man] pages, and [S5] HTML +slide shows. Pandoc's version of markdown contains some enhancements, +like footnotes and embedded LaTeX. In contrast to existing tools for converting markdown to HTML, which use regex substitutions, Pandoc has a modular design: it consists of a @@ -27,12 +27,14 @@ or output format requires only adding a reader or writer. [DocBook XML]: http://www.docbook.org/ [groff man]: http://developer.apple.com/DOCUMENTATION/Darwin/Reference/ManPages/man7/groff_man.7.html [Haskell]: http://www.haskell.org/ +[GNU Texinfo]: http://www.gnu.org/software/texinfo/ © 2006-7 John MacFarlane (jgm at berkeley dot edu). Released under the [GPL], version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.) Recai Oktaş (roktas at debian dot org) deserves credit for the build system, the debian package, and the robust wrapper scripts. +Peter Wang deserves credit for the Texinfo writer. [GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License" @@ -105,16 +107,16 @@ To convert `hello.html` from html to markdown: Supported output formats include `markdown`, `latex`, `context` (ConTeXt), `html`, `rtf` (rich text format), `rst` (reStructuredText), -`docbook` (DocBook XML), `man` (groff man), and `s5` (which produces an -HTML file that acts like powerpoint). Supported input formats include -`markdown`, `html`, `latex`, and `rst`. Note that the `rst` reader only -parses a subset of reStructuredText syntax. For example, it doesn't -handle tables, option lists, or footnotes. But for simple documents it -should be adequate. The `latex` and `html` readers are also limited in -what they can do. Because the `html` reader is picky about the HTML it -parses, it is recommended that you pipe HTML through [HTML Tidy] before -sending it to `pandoc`, or use the `html2markdown` script described -below. +`docbook` (DocBook XML), `texinfo`, `man` (groff man), and `s5` (which +produces an HTML file that acts like powerpoint). Supported input +formats include `markdown`, `html`, `latex`, and `rst`. Note that the +`rst` reader only parses a subset of reStructuredText syntax. For +example, it doesn't handle tables, option lists, or footnotes. But for +simple documents it should be adequate. The `latex` and `html` readers +are also limited in what they can do. Because the `html` reader is picky +about the HTML it parses, it is recommended that you pipe HTML through +[HTML Tidy] before sending it to `pandoc`, or use the `html2markdown` +script described below. If you don't specify a reader or writer explicitly, `pandoc` will try to determine the input and output format from the extensions of @@ -913,6 +915,8 @@ In reStructuredText output, it will be rendered using an interpreted text role `:math:`, as described [here](http://www.american.edu/econ/itex2mml/mathhack.rst). +In Texinfo output, it will be rendered inside a `@math` command. + In groff man output, it will be rendered verbatim without $'s. In RTF and Docbook output, it will be rendered, as far as possible, |