LinuxCommandLibrary

markdown

TLDR

Convert Markdown to HTML

$ markdown [file.md]
copy
Convert from stdin
$ echo "# Hello" | markdown
copy
Output to file
$ markdown [file.md] > [file.html]
copy

SYNOPSIS

markdown [options] [file]

DESCRIPTION

markdown converts Markdown-formatted text to HTML. It implements the original Markdown specification created by John Gruber.
Markdown allows writing in plain text with simple formatting that converts to structured HTML.

PARAMETERS

--html4tags

Use XHTML-style empty tags.
--version
Show version.
--help
Show help.

MARKDOWN SYNTAX

$ # Heading 1
## Heading 2

**bold** and *italic*

- List item
- Another item

[Link](http://example.com)

`code`
copy
code block
$
copy

IMPLEMENTATIONS

$ markdown      - Original Perl
python-markdown - Python
marked        - JavaScript
pandoc        - Haskell (multi-format)
copy

CAVEATS

Many implementations with slight differences. No single standard (CommonMark aims to standardize). Original Markdown is Perl script.

HISTORY

Markdown was created by John Gruber with contributions from Aaron Swartz in 2004. It became the de facto standard for README files and documentation.

SEE ALSO

pandoc(1), marked(1), cmark(1), grip(1)

Copied to clipboard