@qui-cli/log

@qui-cli Plugin: Export usage as markdown


Install

``sh
npm install @qui-cli/markdown @qui-cli/core
`

Usage

See example.

Configuration

`ts
export type Configuration = Plugin.Configuration & {
outputPath?: string;
fileName?: string;
pre?: string;
post?: string;
overwrite?: boolean;
};
`

$3

Path to which to write Markdown output file. If the path does not exist, it will be created. If the path does not have a file extension, it will be assumed to be a directory path (unless it exists as a file), see fileName.

$3

Filename to use for output if outputPath is a path to a directory. Default: "usage.md".

$3

Any Markdown text to prepend to the output.

$3

Amount to increment (or decrement) heading levels in the Markdown output.

$3

Any Markdown text to append to the output.

$3

Whether or not to overwrite an existing file with output. Default: false`