git.iko.soy/typeable/pandoc
on master help sign in
Added documentation for definition lists.
d277baefiddlosopher
README+41−2
compare with master
unifiedsplit
@@ -193,7 +193,7 @@ may be used in Windows under Cygwin.)
193 is not from STDIN, `html2markdown` will attempt to determine the
193 is not from STDIN, `html2markdown` will attempt to determine the
194 page's character encoding from the "Content-type" meta tag.
194 page's character encoding from the "Content-type" meta tag.
195 If this is not present, UTF-8 is assumed.
195 If this is not present, UTF-8 is assumed.
196−
196+
197 The `-g` or `--grabber` option specifies the command to be used to
197 The `-g` or `--grabber` option specifies the command to be used to
198 fetch the contents of a URL:
198 fetch the contents of a URL:
199
199
@@ -421,6 +421,45 @@ the example above:
421 b) Fie
421 b) Fie
422 c. Third
422 c. Third
423
423
424+Definition lists
425+----------------
426+
427+Pandoc supports definition lists, using a syntax inspired by
428+[reStructuredText]'s definition list syntax:
429+
430+ Term 1
431+ Definition 1
432+
433+ Term 2
434+ Definition 2
435+
436+ Second paragraph of definition 2.
437+
438+The terms must fit on one line, but they may contain arbitrary inline
439+markup (emphasis, links, etc.). The definition must begin on the line
440+after the term, indented by one tab stop. The definition consists of
441+one or more block elements (paragraph, code block, list, etc.).
442+Each block must be indented one tab stop.
443+
444+ Term *with inline markup*
445+ Here is the definition. It may
446+ contain multiple blocks. Here is some code:
447+
448+ {* my code *}
449+
450+ Here is the third paragraph of this definition.
451+
452+If you leave space after the definition (as in the first example above),
453+the definitions will be considered paragraphs. In some output formats,
454+this will mean greater spacing between term/definition pairs. For a
455+compact definition list, do not leave space between the definition and
456+the next term:
457+
458+ Term 1
459+ Definition 1
460+ Term 2
461+ Definition 2
462+
424Reference links
463Reference links
425---------------
464---------------
426
465
@@ -528,7 +567,7 @@ of text. Here is an example:
528 Second row 5.0 Here's another one. Note
567 Second row 5.0 Here's another one. Note
529 the blank line between rows.
568 the blank line between rows.
530 ---------------------------------------------------------------
569 ---------------------------------------------------------------
531−
570+
532 Table: Optional caption. This, too, may span multiple
571 Table: Optional caption. This, too, may span multiple
533 lines.
572 lines.
534
573