MARKDOWN-IT(1)

NAME
markdown-it - parse Markdown and write HTML

SYNOPSIS
markdown-it [OPTIONS] [FILE...]

markdown-it --stdin [OPTIONS]

DESCRIPTION
markdown-it converts Markdown to HTML using markdown-it-py.

With one or more FILE arguments, each file is read and rendered to standard output.

With --stdin set, Markdown is read from standard input and rendered to standard output.

Without files and without --stdin, markdown-it starts interactive mode (REPL-style input).

OPTIONS

--stdin
    Read Markdown from standard input.

-v, --version
    Show version information and exit.

-h, --help
    Show help text and exit.

SAFE USAGE
To use markdown-it as a non-interactive filter, always pass --stdin.

Do not rely on implicit stdin redirection such as:

    markdown-it < input.md

That form enters interactive mode, writes prompts to standard output, and can produce unexpected HTML output.

Use this instead:

    markdown-it --stdin < input.md > output.html

EXAMPLES
Render a file:

    markdown-it README.md > README.html

Render multiple files (concatenated output):

    markdown-it header.md body.md footer.md > page.html

Render piped input:

    cat README.md | markdown-it --stdin > README.html