feat: add support for examples

muesli · Sep 8, 2022 · 5040723 · 5040723
1 parent b18accb
commit 5040723
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/mango.go b/mango.go
@@ -22,6 +22,7 @@ type Command struct {
 	Name     string
 	Short    string
 	Usage    string
+	Example  string
 	Flags    map[string]Flag
 	Commands map[string]*Command
 }
@@ -176,6 +177,24 @@ func (m ManPage) buildCommand(w Builder, c Command) {
 			w.IndentEnd()
 		}
 	}
+
+	if c.Example != "" {
+		if c.Name == m.Root.Name {
+			w.Section("Examples")
+			w.TaggedParagraph(-1)
+		} else {
+			w.TaggedParagraph(-1)
+			w.TextBold("EXAMPLES")
+			w.Indent(4)
+		}
+		w.Text(c.Example)
+
+		if c.Name == m.Root.Name {
+			w.EndSection()
+		} else {
+			w.IndentEnd()
+		}
+	}
 }
 
 // Build generates the man page.