doc

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

• func GenerateSummary(dir string) error
• func MaintenanceHandler(flagDescription, defaultValue string) string
• func StrReplaceIfContains(title, old, new string) string
• func WriteDocs(cmd *core.Command, dir string) error
• type FlagDefaultHandler

Functions

func GenerateSummary

func GenerateSummary(dir string) error

func MaintenanceHandler

func MaintenanceHandler(flagDescription, defaultValue string) string

MaintenanceHandler is a concrete strategy for --maintenance-day

func StrReplaceIfContains

func StrReplaceIfContains(title, old, new string) string

func WriteDocs

func WriteDocs(cmd *core.Command, dir string) error

Types

type FlagDefaultHandler

type FlagDefaultHandler func(flagDescription, defaultValue string) string

FlagDefaultHandler is a Strategy for handling pflag default values while generating docs