Documentation
¶
Overview ¶
Package doc generates Markdown files and organizes a directory structure that follows the command hierarchy.
The WriteDocs function is the main entry point for generating the documentation. It recursively processes all subcommands and creates the appropriate files and directories based on the command structure, following the rules defined in determineSubdir
The GenerateSummary function is another entry point, which can create a summary.md file containing the table of contents for the generated documentation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateSummary ¶ added in v6.6.2
func MaintenanceHandler ¶ added in v6.7.0
MaintenanceHandler is a concrete strategy for --maintenance-day
func StrReplaceIfContains ¶ added in v6.7.0
Types ¶
type FlagDefaultHandler ¶ added in v6.7.0
FlagDefaultHandler is a Strategy for handling pflag default values while generating docs