mirror of
https://github.com/RGBCube/serenity
synced 2025-05-18 15:25:08 +00:00
31 lines
568 B
Markdown
31 lines
568 B
Markdown
## Name
|
|
|
|
md - render markdown documents
|
|
|
|
## Synopsis
|
|
|
|
```**sh
|
|
$ md [--html] [input-file.md]
|
|
```
|
|
|
|
## Description
|
|
|
|
Read a Markdown document and render it using either terminal
|
|
escape sequences (the default) or HTML. If a file name is given,
|
|
`md` reads the document from that file; by default it reads its
|
|
standard input.
|
|
|
|
## Options
|
|
|
|
* `-H`, `--html`: Render the document into HTML.
|
|
|
|
## Examples
|
|
|
|
Here's how you can render this man page into HTML:
|
|
|
|
```sh
|
|
$ md --html /usr/share/man/man1/md.md
|
|
```
|
|
|
|
## See Also
|
|
* [`man`(1)](help://man/1/man) to more easily read manpages
|