@qui-cli/log

@qui-cli Plugin: Export usage as markdown

Install

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

Usage

See example.

Configuration

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

outputPath

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.

fileName

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

pre

Any Markdown text to prepend to the output.

headingLevelAdjustment

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

post

Any Markdown text to append to the output.

overwrite

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