args-md

English | 简体中文

The CLI tool that output the help message of args as markdown.

:green_book: Quick Start

:wrench: CLI

your_cli help | npx args-md > cli.md

Demo

:book: Library

import { parseHelp, formatHelp } from 'args-md';

// the array of string of the help text grouped by line
const contents: string[] = [];

const help = parseHelp(contents);

const md = formatHelp(contents);

You can find the type definitions of help in src/global.d.ts.