docs

package

v0.1.0 Latest Latest Go to latest Published: Mar 18, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/microsoft/azure-linux-dev-tools

Links

Open Source Insights

Documentation ¶

Index ¶

func CheckOutputDir(fs opctx.FS, options *GenerateMarkdownOptions) error
func GenerateMarkdownDocs(fs opctx.FS, rootCmd *cobra.Command, options *GenerateMarkdownOptions) error
func OnAppInit(app *azldev.App)
type GenerateMarkdownOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckOutputDir ¶

func CheckOutputDir(fs opctx.FS, options *GenerateMarkdownOptions) error

CheckOutputDir verifies the output directory state before generation. If the directory exists and is non-empty, it either removes it (when Force is set) or returns an actionable error suggesting --force / -f.

func GenerateMarkdownDocs ¶

func GenerateMarkdownDocs(fs opctx.FS, rootCmd *cobra.Command, options *GenerateMarkdownOptions) error

GenerateMarkdownDocs generates markdown documentation for the given command tree.

func OnAppInit ¶

func OnAppInit(app *azldev.App)

Called once when the app is initialized; registers any commands or callbacks with the app.

Types ¶

type GenerateMarkdownOptions ¶

type GenerateMarkdownOptions struct {
	OutputDir     string
	IncludeHidden bool
	Force         bool
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL