The hoedown program

The package compiles and installs the program hoedown, which can process input Markdown documents and generate HTML output using the built–in HTML renderer. Synopsis:

     hoedown [OPTION]... [FILE]

Process the Markdown in ‘FILE’ (or standard input) and render it to standard output, using the Hoedown library. Parsing and rendering can be customized through the options below. The default is to parse pure markdown and output HTML.

Main options:

-n N

--max-nesting=N

Maximum level of block nesting parsed. Default is 16.

-t

--toc-level=N

Maximum level for headers included in the Table of Contents. Zero disables the inclusion of Table of Contents in the output (the default).

--html

Render (X)HTML. The default.

--html-toc

Render the Table of Contents in (X)HTML.

-T

--time

Show time spent in rendering.

-i N

--input-unit=N

Reading block size. Default is 1024.

-o N

--output-unit=N

Writing block size. Default is 64.

-h

--help

Print this help text.

-v

--version

Print Hoedown version.

Block extensions:

--tables

Parse PHP-Markdown style tables.

--fenced-code

Parse fenced code blocks.

--footnotes

Parse footnotes.

--all-block

Enable all of the above.

Span extensions:

--autolink

Automatically turn safe URLs into links.

--strikethrough

Parse ‘~~stikethrough~~’ spans.

--underline

Parse ‘_underline_’ instead of emphasis.

--highlight

Parse ‘==highlight==’ spans.

--quote

Render “quotes” as ‘<q>quotes</q>’.

--superscript

Parse ‘super^script’.

--math

Parse TeX ‘$$math$$’ syntax, Kramdown style.

--all-span

Enable all of the above.

Other flags:

--disable-intra-emphasis

Disable ‘emphasis_between_words’.

--space-headers

Require a space after ‘#’ in headers.

--math-explicit

Instead of guessing by context, parse ‘$inline math$’ and ‘$$always block math$$’ (requires --math).

--all-flags

Enable all of the above.

Negative flags:

--disable-indented-code

Don't parse indented code blocks.

--all-negative

Enable all of the above.

HTML-specific options:

--skip-html

Strip all HTML tags.

--escape

Escape all HTML.

--hard-wrap

Render each linebreak as ‘<br>’.

--xhtml

Render XHTML.

Flags and extensions can be negated by prepending ‘no’ to them, as in --no-tables, --no-span or --no-escape. Options are processed in order, so in case of contradictory options the last specified stands.

When ‘FILE’ is ‘-’, read standard input. If no ‘FILE’ was given, read standard input. Use -- to signal end of option parsing. Exit status is: ‘0’ if no errors occurred, ‘1’ with option parsing errors, ‘4’ with memory allocation errors or ‘5’ with I/O errors.

The smartypants program

The package compiles and installs the program smartypants, which translates plain ASCII punctuation characters into “smart” typographic punctuation HTML entities. smartypants performs the following transformations:

• Straight quotes into “curly” quote HTML entities. The input text:

            <p>"Hello" 'World'!</p>
  

  is converted to:

            <p>&ldquo;Hello&rdquo; &lsquo;World&rsquo;!</p>
  

• Backticks–style quotes into curly quote HTML entities. The input text:

            <p>``Hello World!''</p>
  

  is converted to:

            <p>&ldquo;Hello World!&rdquo;</p>
  

• Dashes (‘--’ and ‘---’) into en- and em-dash entities. The input text:

            <p>Trouble--maker---that is what you are!</p>
  

  is converted to:

            <p>Trouble&ndash;maker&mdash;that is what you are!</p>
  

• Three consecutive dots (‘...’) into an ellipsis entity.

Synopsis:

     smartypants [OPTION]... [FILE]

Apply SmartyPants smart punctuation to the HTML in ‘FILE’ (or standard input), and output the resulting HTML to standard output.

Main options:

-T

--time

Show time spent in SmartyPants processing.

-i N

--input-unit=N

Reading block size. Default is 1024.

-o N

--output-unit=N

Writing block size. Default is 64.

-h

--help

Print this help text.

-v

--version

Print Hoedown version.

Options are processed in order, so in case of contradictory options the last specified stands.

When ‘FILE’ is ‘-’, read standard input. If no ‘FILE’ was given, read standard input. Use ‘--’ to signal end of option parsing. Exit status is: ‘0’ if no errors occurred, ‘1’ with option parsing errors, ‘4’ with memory allocation errors or ‘5’ with I/O errors.