Type alias GenerateDocumentationOptions
GenerateDocumentationOptions: {
generateCliAppsHelpInReadmeOptions?: null | GenerateHelpOfCliAppsInMarkdownFormatOptions & {
placeholder?: string;
};
generateTableOfContentsForMarkdownOptions?: null | GenerateTableOfContentsForMarkdownOptions & {
placeholder?: string;
};
generateUsageWaysOfNpmCliAppsInMarkdownFormatOptions?: null | GenerateUsageWaysOfNpmCliAppsInMarkdownFormatOptions & {
placeholder?: string;
};
readmeFilePath?: string;
}
Type declaration
-
Optional generateCliAppsHelpInReadmeOptions?: null | GenerateHelpOfCliAppsInMarkdownFormatOptions & {
placeholder?: string;
}
-
Optional generateTableOfContentsForMarkdownOptions?: null | GenerateTableOfContentsForMarkdownOptions & {
placeholder?: string;
}
-
Optional generateUsageWaysOfNpmCliAppsInMarkdownFormatOptions?: null | GenerateUsageWaysOfNpmCliAppsInMarkdownFormatOptions & {
placeholder?: string;
}
-
Optional readmeFilePath?: string