updated docs generation program

Author: allmightyspiff

docs/main.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"strings"
 	"encoding/json"
+	"regexp"
 
 	"text/template"
 	// "sort"
@@ -99,6 +100,7 @@ func CliDocs() {
 func PrintMakrdown(cmd SlCmdGroup) {
 
 	var cmdTemplate = `<!-- THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT -->
+<!-- markdownlint-disable first-heading-h1 lastupdated-misformat-or-missing frontmatter-yaml -->
 {{range .Commands}}
 ## ibmcloud {{.CommandPath}}
 {: #{{.CommandShortLink}}}
@@ -130,8 +132,26 @@ ibmcloud {{.Use}}
 }
 
 func getLongHelp(helpString string) string {
+	// Removes some ugly empty lines sometimes.
+	empty_line := regexp.MustCompile(`(?m)^(\t)+$`)
+	helpString = empty_line.ReplaceAllString(helpString, "")
 	helpString = strings.ReplaceAll(helpString, "${COMMAND_NAME}", "ibmcloud")
-	helpString = strings.ReplaceAll(helpString, "EXAMPLE:", "**Examples**:\n")
+	example_regex := regexp.MustCompile(`(?i)Example:+`)
+	helpString = example_regex.ReplaceAllString(helpString, "**Examples**:\n")
+	// for 'indented-by-two'
+	indent_regex := regexp.MustCompile(`(?m)^\s{2}(\S)`)
+	helpString = indent_regex.ReplaceAllString(helpString, "    $1")
+
+	return getFlagHelp(helpString)
+}
+
+func getFlagHelp(helpString string) string {
+	// for 'no-inline-html' errors
+	fake_html_regex := regexp.MustCompile(`<([0-9A-Za-z_\-\.\s]+)>`)
+	helpString = fake_html_regex.ReplaceAllString(helpString, "$1")
+	// for 'no-reversed-links'
+	fake_link_regex := regexp.MustCompile(`\)\[`)
+	helpString = fake_link_regex.ReplaceAllString(helpString, ") [")
 	return helpString
 }
 
@@ -176,7 +196,7 @@ func buildSlCmdFlag(topCommand *cobra.Command) []SlCmdFlag {
 		}
 		thisFlag := SlCmdFlag{
 			Name:flagName,
-			Help: pflag.Usage,
+			Help: getFlagHelp(pflag.Usage),
 			Default: pflag.DefValue,
 		}
 		flags = append(flags, thisFlag)