| 1 |
.\" |
| 2 |
.TH MARKDOWN-CALIBRE "1" "August 2021" "markdown-calibre" "User Commands" |
| 3 |
.SH NAME |
| 4 |
markdown-calibre \- convert Markdown text to XHTML/HTML |
| 5 |
.SH SYNOPSIS |
| 6 |
.B markdown-calibre |
| 7 |
[\fI\,options\/\fR] [\fI\,INPUTFILE\/\fR] |
| 8 |
.PP |
| 9 |
(STDIN is assumed if no INPUTFILE is given) |
| 10 |
.SH DESCRIPTION |
| 11 |
.PP |
| 12 |
A Python implementation of John Gruber's Markdown. |
| 13 |
.IP |
| 14 |
https://python-markdown.github.io/ |
| 15 |
.SH OPTIONS |
| 16 |
.TP |
| 17 |
\fB\-\-version\fR |
| 18 |
show program's version number and exit |
| 19 |
.TP |
| 20 |
\fB\-h\fR, \fB\-\-help\fR |
| 21 |
show this help message and exit |
| 22 |
.TP |
| 23 |
\fB\-f\fR \fI\,OUTPUT_FILE\/\fR, \fB\-\-file\fR=\fI\,OUTPUT_FILE\/\fR |
| 24 |
Write output to \fI\,OUTPUT_FILE\/\fR. Defaults to STDOUT. |
| 25 |
.TP |
| 26 |
\fB\-e\fR \fI\,ENCODING\/\fR, \fB\-\-encoding\fR=\fI\,ENCODING\/\fR |
| 27 |
Encoding for input and output files. |
| 28 |
.TP |
| 29 |
\fB\-o\fR \fI\,OUTPUT_FORMAT\/\fR, \fB\-\-output_format\fR=\fI\,OUTPUT_FORMAT\/\fR |
| 30 |
Use output format 'xhtml' (default) or 'html'. |
| 31 |
.TP |
| 32 |
\fB\-n\fR, \fB\-\-no_lazy_ol\fR |
| 33 |
Observe number of first item of ordered lists. |
| 34 |
.TP |
| 35 |
\fB\-x\fR \fI\,EXTENSION\/\fR, \fB\-\-extension\fR=\fI\,EXTENSION\/\fR |
| 36 |
Load extension \fI\,EXTENSION\/\fR. |
| 37 |
.TP |
| 38 |
\fB\-c\fR \fI\,CONFIG_FILE\/\fR, \fB\-\-extension_configs\fR=\fI\,CONFIG_FILE\/\fR |
| 39 |
Read extension configurations from \fI\,CONFIG_FILE\/\fR. |
| 40 |
\fI\,CONFIG_FILE\/\fR must be of JSON or YAML format. YAML format |
| 41 |
requires that a python YAML library be installed. The |
| 42 |
parsed JSON or YAML must result in a python dictionary |
| 43 |
which would be accepted by the 'extension_configs' |
| 44 |
keyword on the markdown.Markdown class. The extensions |
| 45 |
must also be loaded with the `\-\-extension` option. |
| 46 |
.TP |
| 47 |
\fB\-q\fR, \fB\-\-quiet\fR |
| 48 |
Suppress all warnings. |
| 49 |
.TP |
| 50 |
\fB\-v\fR, \fB\-\-verbose\fR |
| 51 |
Print all warnings. |
| 52 |
.TP |
| 53 |
\fB\-\-noisy\fR |
| 54 |
Print debug messages. |
| 55 |
.SH "SEE ALSO" |
| 56 |
.BR calibre (1) |