cli

func Execute ¶

func Execute() error

Execute executes the root command.

func GenerateDocs ¶ added in v1.2.0

func GenerateDocs(input, output string, verbose bool, sections []types.Section) error

GenerateDocs generates documentation based on the input file or directory.

If the input is a directory, it generates documentation for all 'main.bicep' files in the directory. If the input is a Bicep file, it generates documentation for that file only.

The output is used only when the input is a Bicep file; in other cases it is always set to 'README.md'.

The sections slice contains the sections that should be included in the documentation.

If verbose is true, additional information will be printed during the generation process.