docs

Documentation

Overview

Package docs provides tools for generating user docs from Cobra commands in various formats

Index

• func GenMarkdown(cmd *cobra.Command, w io.Writer) error
• func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
• func GenMarkdownTree(cmd *cobra.Command, dir string) error
• func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
• func GenPydioYaml(cmd *cobra.Command, position int, w io.Writer) error

Functions

func GenMarkdown

func GenMarkdown(cmd *cobra.Command, w io.Writer) error

GenMarkdown creates markdown output.

func GenMarkdownCustom

func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenMarkdownCustom creates custom markdown output.

func GenMarkdownTree

func GenMarkdownTree(cmd *cobra.Command, dir string) error

GenMarkdownTree will generate a markdown page for this command and all descendants in the directory given. The header may be nil. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third`, it is undefined which help output will be in the file `cmd-sub-third.1`.

func GenMarkdownTreeCustom

func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

GenMarkdownTreeCustom is the the same as GenMarkdownTree, but with custom filePrepender and linkHandler.

func GenPydioYaml

func GenPydioYaml(cmd *cobra.Command, position int, w io.Writer) error

GenPydioYaml generates yaml file for pydio docs Sample output title: "Command Name" language: und menu: "Command Name" weight: 1 menu_name: menu-administration-guide