.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "MARKDENT-HTML 1p" .TH MARKDENT-HTML 1p 2024-03-06 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME markdent\-html \- Turn Markdown into HTML with Markdent .SH VERSION .IX Header "VERSION" version 0.40 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& $> markdent\-html \-\-file ./path/to/text.md .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This tool turns Markdown into HTML using Markdent. .SH OPTIONS .IX Header "OPTIONS" This tool accepts the following command line options: .SS \-\-file .IX Subsection "--file" The file containing the Markdown to process. You must provide this or \&\f(CW\*(C`\-\-text\*(C'\fR, but not both. .PP Pass \f(CW\*(C`\-\*(C'\fR to read from \f(CW\*(C`STDIN\*(C'\fR. .SS \-\-text .IX Subsection "--text" The Markdown text to process. You must provide this or \f(CW\*(C`\-\-file\*(C'\fR, but not both. .SS \-\-title .IX Subsection "--title" If you pass then the output will be a full HTML document containing this as the \f(CW\*(C`\*(C'\fR tag. If this isn't passed then the output will be a HTML fragment with no \f(CW\*(C`<html>\*(C'\fR or \f(CW\*(C`<body>\*(C'\fR tags. .SS \-\-charset .IX Subsection "--charset" If you pass with a \f(CW\*(C`\-\-title\*(C'\fR it will be used to populate a \f(CW\*(C`<meta charset="...">\*(C'\fR tag for the document. .SS \-\-language .IX Subsection "--language" If you pass with a \f(CW\*(C`\-\-title\*(C'\fR it will be used to set the \f(CW\*(C`lang\*(C'\fR attribute for the document's \f(CW\*(C`<html>\*(C'\fR tag. .SS \-\-dialects .IX Subsection "--dialects" You can add one or more dialects to the standard parser with this option. This can either be a full class name like \f(CW\*(C`Markdent::Dialect::GitHub\*(C'\fR or just a short name like \f(CW\*(C`GitHub\*(C'\fR. .SH SUPPORT .IX Header "SUPPORT" Bugs may be submitted at <https://github.com/houseabsolute/Markdent/issues>. .PP I am also usually active on IRC as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR. .SH SOURCE .IX Header "SOURCE" The source code repository for Markdent can be found at <https://github.com/houseabsolute/Markdent>. .SH AUTHOR .IX Header "AUTHOR" Dave Rolsky <autarch@urth.org> .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2021 by Dave Rolsky. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .PP The full text of the license can be found in the \&\fILICENSE\fR file included with this distribution.