azldev_docs_markdown.md

azldev docs markdown

Generates Markdown (.md) docs for this tool

Synopsis

Generate Markdown reference documentation for all azldev CLI commands.

Produces one .md file per command in the output directory. These files are auto-generated and should not be hand-edited; update the Cobra command definitions in Go source code instead, then re-run this command.

azldev docs markdown [flags]

Examples

  # Generate docs into the user guide
  azldev docs markdown -o docs/user/reference/cli/

  # Include hidden (advanced) commands
  azldev docs markdown -o docs/user/reference/cli/ --include-hidden

  # Overwrite an existing non-empty output directory
  azldev docs markdown -o docs/user/reference/cli/ -f

Options

  -f, --force               delete and recreate the output directory if it already exists
  -h, --help                help for markdown
      --include-hidden      include hidden commands in the generated docs
  -o, --output-dir string   directory markdown files will be written to

Options inherited from parent commands

  -y, --accept-all                accept all prompts
      --color mode                output colorization mode {always, auto, never} (default auto)
      --config-file stringArray   additional TOML config file(s) to merge (may be repeated)
  -n, --dry-run                   dry run only (do not take action)
      --network-retries int       maximum number of attempts for network operations (minimum 1) (default 3)
      --no-default-config         disable default configuration
  -O, --output-format fmt         output format {csv, json, markdown, table} (default table)
      --permissive-config         do not fail on unknown fields in TOML config files
  -C, --project string            path to Azure Linux project
  -q, --quiet                     only enable minimal output
  -v, --verbose                   enable verbose output

SEE ALSO

• azldev docs - Documentation commands