aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 51fde849b5a048eb071a4668e36df756f0316013 (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
# convert-markdown

Extremely simple Markdown to HTML converter using [lowdown(3)][lowdown].

## Usage

Pass Markdown to stdin and get an HTML fragment on stdout:

```console
$ convert-markdown
# header
hello **world**
[Ctrl-D]
<h1 id="header">header</h1>

<p>hello <strong>world</strong></p>
$ convert-markdown < file.md > output.html
```

## License

Portions of this code are adapted from the example section of [lowdown_file(3)][lowdown_file], which is part of
[lowdown][lowdown-site] by Kristaps Dzonsons <kristaps@bsd.lv>. Lowdown is free software released under the terms of
the [ISC license][isc], therefore this program is as well, unless otherwise specified in the source code.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,
provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

[lowdown]: https://kristaps.bsd.lv/lowdown/lowdown.3.html
[lowdown_file]: https://kristaps.bsd.lv/lowdown/lowdown_file.3.html
[lowdown-site]: https://kristaps.bsd.lv/lowdown/
[isc]: https://opensource.org/license/isc-license-txt/