md-utils(1p) · carta

Usage

md-utils [options] [markdown-file]

Utility to add a table of contents and other goodies to your GitHub flavored markdown.

`•`	Add `"@TOC@"` where you want to see your TOC.
`•`	Add `"@TOC_BACK@"` to insert an internal link to TOC.
`•`	Add `"@DATE(`format-str`)@"` where you want to see a formatted date.
`•`	Add `"@GIT_USER@"` where you want to see your git user name.
`•`	Add `"@GIT_EMAIL@"` where you want to see your git email address.
`•`	Use the --render option to render the HTML for the markdown

 md-utils README.md.in > README.md
 md-utils -r README.md.in

-e, --engine: Engine to use, options: github, text_markdown (default: text_markdown).

-m, --mode: For GitHub API mode is 'gfm' or 'markdown' (default: markdown).

-t, --title: String to use for a custom title, default: "Table of Contents".

•: Use "!#" to prevent a header from being include in the table of contents. Add your own custom back to TOC message "@TOC_BACK(Back to Index)@".

•: Date format strings are based on format strings supported by the Perl module Date::Format. The default format is "%Y-%m-%d" if no format is given.

•: Use the --nobody tag to return the HTML without the "<html><body></body></html>" wrapper. --raw mode will also return HTML without wrapper.

This program is free software; you can use it and/or distribute it under the same terms as Perl itself.