docs

Author: azahnen

README.md

@@ -1,3 +1,3 @@
 # xtraplatform-cli
 
-Command line tools for [xtraplatform](interactive-instruments/xtraplatform).
+Command line tools for [xtraplatform](https://github.com/interactive-instruments/xtraplatform).

xtractl/README.md

@@ -20,8 +20,8 @@ that would otherwise require a restart.
 
 ### SEE ALSO
 
-* [xtractl entity](xtractl_entity.md)	 - Control entities
-* [xtractl log](xtractl_log.md)	 - Control logging
+* [xtractl entity](#xtractl-entity)	 - Control entities
+* [xtractl log](#xtractl-log)	 - Control logging
 
 ## xtractl entity
 
@@ -44,9 +44,9 @@ Control entities
 
 ### SEE ALSO
 
-* [xtractl](xtractl.md)	 - 
-* [xtractl entity ls](xtractl_entity_ls.md)	 - List entities
-* [xtractl entity reload](xtractl_entity_reload.md)	 - Reload entity configuration
+* [xtractl](#xtractl)
+* [xtractl entity ls](#xtractl-entity-ls)	 - List entities
+* [xtractl entity reload](#xtractl-entity-reload)	 - Reload entity configuration
 
 ## xtractl entity ls
 
@@ -75,7 +75,7 @@ xtractl entity ls [flags]
 
 ### SEE ALSO
 
-* [xtractl entity](xtractl_entity.md)	 - Control entities
+* [xtractl entity](#xtractl-entity)	 - Control entities
 
 ## xtractl entity reload
 
@@ -105,7 +105,7 @@ xtractl entity reload id1,id2
 
 ### SEE ALSO
 
-* [xtractl entity](xtractl_entity.md)	 - Control entities
+* [xtractl entity](#xtractl-entity)	 - Control entities
 
 ## xtractl log
 
@@ -122,10 +122,10 @@ Control logging
 
 ### SEE ALSO
 
-* [xtractl](xtractl.md)	 - 
-* [xtractl log filter](xtractl_log_filter.md)	 - Switch the log filters
-* [xtractl log level](xtractl_log_level.md)	 - Change the log level
-* [xtractl log status](xtractl_log_status.md)	 - Show log status
+* [xtractl](#xtractl)
+* [xtractl log filter](#xtractl-log-filter)	 - Switch the log filters
+* [xtractl log level](#xtractl-log-level)	 - Change the log level
+* [xtractl log status](#xtractl-log-status)	 - Show log status
 
 ## xtractl log filter
 
@@ -160,7 +160,7 @@ xtractl log filter "*" --disable
 
 ### SEE ALSO
 
-* [xtractl log](xtractl_log.md)	 - Control logging
+* [xtractl log](#xtractl-log)	 - Control logging
 
 ## xtractl log level
 
@@ -188,7 +188,7 @@ xtractl log level DEBUG
 
 ### SEE ALSO
 
-* [xtractl log](xtractl_log.md)	 - Control logging
+* [xtractl log](#xtractl-log)	 - Control logging
 
 ## xtractl log status
 
@@ -216,5 +216,5 @@ xtractl log status [flags]
 
 ### SEE ALSO
 
-* [xtractl log](xtractl_log.md)	 - Control logging
+* [xtractl log](#xtractl-log)	 - Control logging
 

xtractl/cmd/docs.go

@@ -105,9 +105,13 @@ func generateMarkdown(cmd *cobra.Command, w io.Writer) error {
 		if cmd.HasParent() {
 			parent := cmd.Parent()
 			pname := parent.CommandPath()
-			link := pname + ".md"
-			link = strings.Replace(link, " ", "_", -1)
-			buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, link, parent.Short))
+			link := "#" + pname
+			link = strings.Replace(link, " ", "-", -1)
+			short := ""
+			if len(parent.Short) > 0 {
+				short = fmt.Sprintf("\t - %s", parent.Short)
+			}
+			buf.WriteString(fmt.Sprintf("* [%s](%s)%s\n", pname, link, short))
 			cmd.VisitParents(func(c *cobra.Command) {
 				if c.DisableAutoGenTag {
 					cmd.DisableAutoGenTag = c.DisableAutoGenTag
@@ -123,9 +127,13 @@ func generateMarkdown(cmd *cobra.Command, w io.Writer) error {
 				continue
 			}
 			cname := name + " " + child.Name()
-			link := cname + ".md"
-			link = strings.Replace(link, " ", "_", -1)
-			buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, link, child.Short))
+			link := "#" + cname
+			link = strings.Replace(link, " ", "-", -1)
+			short := ""
+			if len(child.Short) > 0 {
+				short = fmt.Sprintf("\t - %s", child.Short)
+			}
+			buf.WriteString(fmt.Sprintf("* [%s](%s)%s\n", cname, link, short))
 		}
 		buf.WriteString("\n")
 	}