markdown

Documentation

Index

• Variables
• func FormatMarkdown(in []byte) ([]byte, error)
• func Render(app *cli.App, opt ...Option) (string, error)
• func ReplaceBetween(start, end string, where, with string) (string, error)
• type Markdown
• type Option
  • func WithAppPath(path string) Option
  • func WithTemplate(tmpl string) Option

Variables

var DefaultMarkdownTemplate string

Functions

func FormatMarkdown

func FormatMarkdown(in []byte) ([]byte, error)

FormatMarkdown formats given Markdown content (like a `go fmt`, but for markdown).

func Render

func Render(app *cli.App, opt ...Option) (string, error)

Render renders the markdown documentation for the given cli app.

Deprecated: Use <https://github.com/urfave/cli/pull/1722> instead.

func ReplaceBetween

func ReplaceBetween(start, end string, where, with string) (string, error)

ReplaceBetween replaces the text between the given start and end markers (tags).

Deprecated: Use <https://github.com/urfave/cli/pull/1722> instead.

Types

type Markdown

type Markdown struct {
	// contains filtered or unexported fields
}

Markdown is a markdown formatter.

type Option

type Option func(*Markdown)

Option is a markdown formatter option.

func WithAppPath

func WithAppPath(path string) Option

WithAppPath allows to override the default app path.

func WithTemplate

func WithTemplate(tmpl string) Option

WithTemplate allows to override the default template.