info

Documentation

Index

• Constants
• Variables
• func ToMan(a *cli.App) (string, error)
• func ToMarkdown(a *cli.App) (string, error)

Constants

const AppName string = "gw-aws-audit"

AppName defined the application name

const AppRepoOwner string = "GoodwayGroup Tech"

AppRepoOwner defined the owner of the repo on GitHub

Variables

var MarkdownDocTemplate = `% {{ .App.Name }} 8
# NAME
{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }}
# SYNOPSIS
{{ .App.Name }}
{{ if .SynopsisArgs }}
` + "```" + `
{{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + `
{{ end }}{{ if .App.UsageText }}
# DESCRIPTION
{{ .App.UsageText }}
{{ end }}

# COMMAND TREE
{{ range $v := .TOC }}
{{ $v }}{{ end }}

**Usage**:
` + "```" + `
{{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
` + "```" + `
{{ if .GlobalArgs }}
# GLOBAL OPTIONS
{{ range $v := .GlobalArgs }}
{{ $v }}{{ end }}
{{ end }}{{ if .Commands }}
# COMMANDS
{{ range $v := .Commands }}
{{ $v }}{{ end }}{{ end }}`

Functions

func ToMan

func ToMan(a *cli.App) (string, error)

ToMan creates a man page string for the `*App` The function errors if either parsing or writing of the string fails.

func ToMarkdown

func ToMarkdown(a *cli.App) (string, error)

ToMarkdown creates a markdown string for the `*App` The function errors if either parsing or writing of the string fails.