docs

Documentation

Index

• Variables
• func MustStyle(n string) string
• func NewHelpTopicCmd(t Topic) *cobra.Command
• func Render(md string) (string, error)
• func WithBaseURL() glamour.TermRendererOption
• func WithWrap(w int) glamour.TermRendererOption
• func WithoutIndentation() glamour.TermRendererOption
• type Topic

Variables

var Topics = []Topic{
	{File: "man/expr-lang.md", Desc: "Overview for expr (built-in expression language)"},
	{File: "contributing.md", Desc: "Information for improving Heimdall"},
	{File: "formatting.md", Desc: "Description of output formats and filters"},
	{File: "source.md", Desc: "Instructions for building Heimdall from source"},
	{File: "why.md", Desc: fmt.Sprintf("Why %s?", color.New(color.Italic).Sprint("Heimdall"))},
}

Functions

func MustStyle

func MustStyle(n string) string

func NewHelpTopicCmd

func NewHelpTopicCmd(t Topic) *cobra.Command

func Render

func Render(md string) (string, error)

Render returns the markdown rendered as a string. It does a series of checks to detect terminal width, color scheme, etc. to achieve the best possible formatting.

func WithBaseURL

func WithBaseURL() glamour.TermRendererOption

WithBaseURL sets the base URL for relative links to the location of the GitHub project.

func WithWrap

func WithWrap(w int) glamour.TermRendererOption

WithWrap sets the word wrap to w columns.

func WithoutIndentation

func WithoutIndentation() glamour.TermRendererOption

WithoutIndentation removes margins to produce dense output.

Types

type Topic

type Topic struct {
	File string
	Desc string
}