Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MKD2HTML(1)		  BSD General Commands Manual		   MKD2HTML(1)

NAME
     mkd2html -- convert a markdown document into (X)HTML

SYNOPSIS
     mkd2html [-dHhmnx]	[file]

DESCRIPTION
     mkd2html utility reads file and generates (X)HTML input from markdown
     source.  If unspecified, file is taken to be standard input.

     By	default, mkd2html implies -H and -m options.

     The options are as	follows:

     -d, --discount
	     enable Discount extensions:

	     +o	image size specification, by appending "=(width)x(height)" to
		the link

	     +o	pseudo-protocols in links:

		+o  abbr:description for	<abbr title="description">...</abbr>

		+o  class:name for <span	class="name">...</span>

		+o  id:name for <span id="name">...</span>

		+o  raw:text for	verbatim unprocessed text inclusion

	     +o	class blocks: blockquotes beginning with %class% will be ren-
		dered as a div of the given class(es)

	     and PHP-Markdown-like tables.

     -H, --html
	     output HTML (self-closing tags like: <br>).

     -h, --help
	     display help text.

     -m, --markdown
	     disable all extensions and	use strict markdown syntax.

     -n, --natext
	     enable Discount extensions	and Natasha's own extensions:

	     +o	id attribute for headers, using	the syntax id#Header text

	     +o	class attribute	for paragraphs,	by putting class name(s) be-
		tween parenthesis at the very beginning	of the paragraph

	     +o	<ins> and <del>	spans, using respectively ++ and -- as delim-
		iters (with emphasis-like restrictions,	i.e. an	opening	delim-
		iter cannot be followed	by a whitespace, and a closing delim-
		iter cannot be preceded	by a whitespace)

	     +o	plain <span> without attribute,	using emphasis-like delimiter
		|

     -x, --xhtml
	     output XHTML (self-closing	tags like: <br />).

EXIT STATUS
     The mkd2html utility exits	0 on success, and >0 if	an error occurs.

SEE ALSO
     mkd2latex(1), mkd2man(1)

AUTHORS
     mkd2html was written by Natasha "Kerensikova" Porte
     <natacha@instinctive.eu>.	Manual page was	originally written by Massimo
     Manghi <mxmanghi@apache.org>, and rewritten to mdoc format	by Svyatoslav
     Mishyn <juef@openmailbox.org>.

BSD				 March 1, 2016				   BSD

NAME | SYNOPSIS | DESCRIPTION | EXIT STATUS | SEE ALSO | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mkd2html&sektion=1&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help