Documentation
¶
Overview ¶
Package clidoc renders the command reference of tt as Markdown pages from the command tree tt runs: a page for every top-level command, with its subcommands under it, a page for every help topic, and an index of them.
The text is the one --help prints - the description, the usage, the flags and the examples of every command - so that the reference says what tt says and changes with it. The pages are generated, not edited: the help of a command is where its text is written.
Index ¶
Constants ¶
const (
// IndexPage is the page of the root command, which lists the others.
IndexPage = "index.md"
)
Variables ¶
This section is empty.
Functions ¶
func Markdown ¶
Markdown renders a help text as Markdown. A help text is plain text wrapped for a terminal: paragraphs at the margin, lists of "* " or "- " items, and indented lines that keep their layout. The paragraphs and the lists become Markdown ones, with every character Markdown would take for markup escaped, and the indented lines a code block.
Types ¶
This section is empty.
Source Files