github.com/ActiveState/cli@v0.0.0-20240508170324-6801f60cd051/internal/runners/export/docs/docs.md.tpl (about)

     1  {{$currentGroup := ""}}
     2  {{- range .Commands}}
     3  {{- if and (ne $currentGroup .Group.String) (ne .Group.String "")}}
     4  {{- $currentGroup = .Group.String}}
     5  
     6  ## {{.Group.String}}{{end}}
     7  
     8  ### {{.NameRecursive}} {{ if .Unstable }}(unstable) {{ end }}
     9  {{.Description}}
    10  
    11  **Usage**
    12  ```text
    13  {{.NameRecursive}} {{if .Flags}}[flags]{{end}}{{range .Arguments}} <{{ .Name }}>{{end}}
    14  ```
    15  
    16  {{- if .Examples }}
    17  
    18  **Examples**
    19  {{- range .Examples }}
    20  ```text
    21  {{ . }}
    22  ```
    23  {{- end }}
    24  {{- end }}
    25  
    26  {{- if .Arguments}}
    27  
    28  **Arguments**
    29  {{-  range .Arguments }}
    30  * `<{{ .Name }}>`{{ if not .Required }} (optional){{ end }} {{ .Description }}
    31  {{-  end }}
    32  {{- end}}
    33  {{- if .Flags}}
    34  
    35  **Flags**
    36  {{- range .Flags}}
    37  * `--{{.Name}}`{{if .Shorthand}}, `-{{.Shorthand}}`{{end}} {{.Description}}
    38  {{- end}}
    39  {{- end}}
    40  {{- end}}