rdme
Version:
ReadMe's official CLI and GitHub Action.
18 lines (17 loc) • 891 B
TypeScript
type Section = 'Changelog' | 'Custom Pages' | 'Guides' | 'Reference';
type Command = 'docs' | 'reference' | 'changelog' | 'custompages';
export declare function summary(section: Section): string;
export declare function description(section: Section, command: Command): string;
export declare function args(section: Section): {
folder: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
};
export declare function examples(section: Section): {
description: string;
command: string;
}[];
export declare function flags(section: Section): {
'docs-only'?: import("@oclif/core/interfaces").BooleanFlag<boolean> | undefined;
branch: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
key: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
};
export {};