diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 28 |
1 files changed, 26 insertions, 2 deletions
@@ -40,6 +40,16 @@ 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. +Because Pandoc's intermediate representation of a document is less +expressive than many of the formats it converts between, one should +not expect perfect conversions between every format and every other. +Pandoc attempts to preserve the structural elements of a document, but +not formatting details such as margin size. And some document elements, +such as complex tables, may not fit into Pandoc's simple document +model. While conversions from Pandoc's Markdown to all formats aspire +to be perfect, conversions from formats more expressive than Pandoc's +Markdown can be expected to be lossy. + Using `pandoc` -------------- @@ -240,6 +250,13 @@ General options `epub.css`, `templates`, `slidy`, `slideous`, or `s5` directory placed in this directory will override pandoc's normal defaults. +`--bash-completiion` + +: Generate a bash completion script. to enable bash completion + with pandoc, add this to your `.bashrc`: + + eval "$(pandoc --bash-completion)" + `--verbose` : Give verbose debugging output. Currently this only has an effect @@ -1295,8 +1312,8 @@ Block quotations Markdown uses email conventions for quoting blocks of text. A block quotation is one or more paragraphs or other block elements (such as lists or headers), with each line preceded by a `>` character -and a space. (The `>` need not start at the left margin, but it should -not be indented more than three spaces.) +and an optional space. (The `>` need not start at the left margin, but +it should not be indented more than three spaces.) > This is a block quote. This > paragraph has two lines. @@ -1320,6 +1337,13 @@ other block quotes. That is, block quotes can be nested: > > > A block quote within a block quote. +If the `>` character is followed by an optional space, that space +will be considered part of the block quote marker and not part of +the indentation of the contents. Thus, to put an indented code +block in a block quote, you need five spaces after the `>`: + + > code + #### Extension: `blank_before_blockquote` #### Standard markdown syntax does not require a blank line before a block |