docs

Documentation

Overview

Package docs contains the functions to generate the markdown documentation for provided commands.

Index

• func GenCommandMarkdown(cmd *cobra.Command, w io.Writer, isParent bool) error
• func GenCommandPage(cmd *cobra.Command, dir string, genChildrenPages bool, level int) error

Functions

func GenCommandMarkdown

func GenCommandMarkdown(cmd *cobra.Command, w io.Writer, isParent bool) error

GenCommandMarkdown generates the markdown for the given command.

func GenCommandPage

func GenCommandPage(cmd *cobra.Command, dir string, genChildrenPages bool, level int) error

GenCommandPage generates the markdown documentation for the provided command and its children. If genChildrenPages is true, it generates a separate markdown file for each child command. If level is greater than 1, it generates a second level paragraph.