diff options
author | John MacFarlane <fiddlosopher@gmail.com> | 2012-01-20 21:22:51 -0800 |
---|---|---|
committer | John MacFarlane <fiddlosopher@gmail.com> | 2012-01-20 21:22:51 -0800 |
commit | 1d615908c2c346c034aa63f572f5f112638d8ff4 (patch) | |
tree | 1ce3dc4984020a3a7dac69ed032450a4dc7c9f7e /README | |
parent | b4a6c023431fcb313f04afa4c0d222c977c6d27c (diff) | |
download | pandoc-1d615908c2c346c034aa63f572f5f112638d8ff4.tar.gz |
Removed markdown2pdf and documentation.
Diffstat (limited to 'README')
-rw-r--r-- | README | 62 |
1 files changed, 22 insertions, 40 deletions
@@ -17,7 +17,8 @@ and [LaTeX]; and it can write plain text, [markdown], [reStructuredText], [XHTML], [HTML 5], [LaTeX], [LaTeX beamer], [ConTeXt], [RTF], [DocBook XML], [OpenDocument XML], [ODT], [Word docx], [GNU Texinfo], [MediaWiki markup], [EPUB], [Textile], [groff man] pages, [Emacs Org-Mode], [AsciiDoc], and [Slidy], -[DZSlides], or [S5] HTML slide shows. +[DZSlides], or [S5] HTML slide shows. It can also produce [PDF] output +on systems where LaTeX is installed. Pandoc's enhanced version of markdown includes syntax for footnotes, tables, flexible ordered lists, definition lists, delimited code blocks, @@ -34,14 +35,15 @@ representation of the document, and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer. -Using Pandoc ------------- +Using `pandoc` +-------------- If no *input-file* is specified, input is read from *stdin*. Otherwise, the *input-files* are concatenated (with a blank line between each) and used as input. Output goes to *stdout* by default (though output to *stdout* is disabled for the `odt`, `docx`, -and `epub` output formats). For output to a file, use the `-o` option: +`pdf`, and `epub` output formats). For output to a file, use the +`-o` option: pandoc -o output.html input.txt @@ -89,36 +91,15 @@ should pipe input and output through `iconv`: iconv -t utf-8 input.txt | pandoc | iconv -f utf-8 -Wrappers -======== - `markdown2pdf` -------------- -The standard Pandoc installation includes `markdown2pdf`, a wrapper -around `pandoc` and `pdflatex` that produces PDFs directly from markdown -sources. The default behavior of `markdown2pdf` is to create a file with -the same base name as the first argument and the extension `pdf`; thus, -for example, - - markdown2pdf sample.txt endnotes.txt - -will produce `sample.pdf`. An output file -name can be specified explicitly using the `-o` option: - - markdown2pdf -o book.pdf chap1 chap2 - -If no input file is specified, input will be taken from *stdin*. -All of `pandoc`'s options will work with `markdown2pdf` as well. - -`markdown2pdf` assumes that `pdflatex` is in the path. It also -assumes that the following LaTeX packages are available: -`unicode`, `fancyhdr` (if you have verbatim text in footnotes), -`graphicx` (if you use images), `array` (if you use tables), -and `ulem` (if you use strikeout text). If they are not already -included in your LaTeX distribution, you can get them from -[CTAN]. A full [TeX Live] or [MacTeX] distribution will have all of -these packages. +Earlier versions of pandoc came with a program, `markdown2pdf`, +that used pandoc and pdflatex to produce a PDF. This is no +longer needed, since `pandoc` now has a `pdf` output format. +Note that whereas `markdown2pdf` would create an ouput file +based on the input file name, `pandoc` requires that you specify +the output filename explicitly. `hsmarkdown` ------------ @@ -158,12 +139,12 @@ Options (DocBook XML), `opendocument` (OpenDocument XML), `odt` (OpenOffice text document), `docx` (Word docx), `epub` (EPUB book), `asciidoc` (AsciiDoc), `slidy` (Slidy HTML and javascript slide show), `dzslides` (HTML5 + - javascript slide show), `s5` (S5 HTML and javascript slide show), or - `rtf` (rich text format). Note that `odt` and `epub` output will not be - directed to *stdout*; an output filename must be specified using the - `-o/--output` option. If `+lhs` is appended to `markdown`, `rst`, `latex`, - `html`, or `html5`, the output will be rendered as literate Haskell source: - see [Literate Haskell support](#literate-haskell-support), below. + javascript slide show), `s5` (S5 HTML and javascript slide show), + `rtf` (rich text format), or `pdf` (PDF). Note that `odt` and `epub` output + will not be directed to *stdout*; an output filename must be specified + using the `-o/--output` option. If `+lhs` is appended to `markdown`, `rst`, + `latex`, `html`, or `html5`, the output will be rendered as literate Haskell + source: see [Literate Haskell support](#literate-haskell-support), below. `-s`, `--standalone` : Produce output with an appropriate header and footer (e.g. a @@ -172,7 +153,7 @@ Options `-o` *FILE*, `--output=`*FILE* : Write output to *FILE* instead of *stdout*. If *FILE* is `-`, output will go to *stdout*. (Exception: if the output - format is `odt`, `docx`, or `epub`, output to stdout is disabled.) + format is `odt`, `docx`, `pdf`, or `epub`, output to stdout is disabled.) `-p`, `--preserve-tabs` : Preserve tabs instead of converting them to spaces (the default). @@ -1937,8 +1918,8 @@ Producing slide shows with Pandoc You can use Pandoc to produce an HTML + javascript slide presentation that can be viewed via a web browser. There are three ways to do this, using [S5], [DZSlides], or [Slidy]. You can also produce a PDF slide -show using [LaTeX beamer]: just pass the `--beamer` option to -`markdown2pdf`. +show using [LaTeX beamer]: just use the `--beamer` option with `pdf` +output. Here's the markdown source for a simple slide show, `eating.txt`: @@ -2094,3 +2075,4 @@ Christopher Sawicki, Kelsey Hightower. [DZSlides]: http://paulrouget.com/dzslides/ [ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime [Word docx]: http://www.microsoft.com/interop/openup/openxml/default.aspx +[PDF]: http://www.adobe.com/pdf/
\ No newline at end of file |