summaryrefslogtreecommitdiff
path: root/man/man1/hsmarkdown.1.md
blob: 46b5bd6850820a0ded4b859afa95d1fb0c531ae1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
% HSMARKDOWN | 1
% John MacFarlane
% June 30, 2007

# NAME

hsmarkdown - convert markdown-formatted text to HTML

# SYNOPSIS

hsmarkdown [*input-file*]...

# DESCRIPTION

`hsmarkdown` converts markdown-formatted text to HTML. It is designed
to be usable as a drop-in replacement for John Gruber's `Markdown.pl`.

If no *input-file* is specified, input is read from STDIN.
Otherwise, the *input-files* are concatenated (with a blank
line between each) and used as input.  Output goes to STDOUT by
default.  For output to a file, use shell redirection:

    hsmarkdown input.txt > output.html

`hsmarkdown` uses the UTF-8 character encoding for both input and output.
If your local character encoding is not UTF-8, you should pipe input
and output through `iconv`:

    iconv -t utf-8 input.txt | hsmarkdown | iconv -f utf-8

`hsmarkdown` is implemented as a wrapper around `pandoc`(1).  It
calls `pandoc` with the options `--from markdown --to html
--strict` and disables all other options.  (Command-line options
will be interpreted as filenames, as they are by `Markdown.pl`.)

# SEE ALSO

`pandoc`(1).  The *README*
file distributed with Pandoc contains full documentation.

The Pandoc source code and all documentation may be downloaded from
<http://sophos.berkeley.edu/macfarlane/pandoc/>.