import Documenter from 'shinka-cli/src/Documenter/Documenter.js'

public class | source

Documenter

Generates markdown documentation for commands.

Documenter.generate();

Documenter.generate(cmds);

Documenter.generate(cmds, "to/a/path.md");

Static Method Summary

Static Public Methods
public static	generate(commands: Command[], path: string) Generates documentation and write to file.

Generates documentation and write to file.

Name	Type	Attribute	Description
commands	Command[]	optional default: defaultCommands	Defaults to exported commands
path	string	optional default: "manual/usage.md"	File to write to

Documenter.generate();

Documenter.generate(cmds);

Documenter.generate(cmds, "to/a/path.md");