cespec

Documentation

Index

• func Generate(outputDir string)
• type MarkDown
  • func NewMarkDown() *MarkDown
  • func (m *MarkDown) Bullet() *MarkDown
  • func (m *MarkDown) CodeBlock(code, t string) *MarkDown
  • func (m *MarkDown) Link(text, url string) *MarkDown
  • func (m *MarkDown) MultiBr(lineBreaks int) *MarkDown
  • func (m *MarkDown) String() string
  • func (m *MarkDown) Title(title string, level int) *MarkDown
  • func (m *MarkDown) UpLink() *MarkDown
  • func (m *MarkDown) Write(str string) *MarkDown
  • func (m *MarkDown) WriteLineBreak() *MarkDown
  • func (m *MarkDown) Writeln(str string) *MarkDown

Functions

func Generate

func Generate(outputDir string)

Generate produces a cloudevents.md file in the provided outputDir path

Types

type MarkDown

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

MarkDown represents a MarkDown (*.md) file content

func NewMarkDown

func NewMarkDown() *MarkDown

NewMarkDown creates a new MarkDown instance

func (*MarkDown) Bullet

func (m *MarkDown) Bullet() *MarkDown

Bullet creates and appends a bullet point to the md document

func (*MarkDown) CodeBlock

func (m *MarkDown) CodeBlock(code, t string) *MarkDown

CodeBlock creates and appends a Code block to the md document

func (*MarkDown) Link

func (m *MarkDown) Link(text, url string) *MarkDown

Link creates and appends a md link to the md document

func (*MarkDown) MultiBr

func (m *MarkDown) MultiBr(lineBreaks int) *MarkDown

MultiBr appends multiple newlines to the md document

func (*MarkDown) String

func (m *MarkDown) String() string

String prints the current state of the md document

func (*MarkDown) Title

func (m *MarkDown) Title(title string, level int) *MarkDown

Title creates and appends a md title with given level to the md document

func (*MarkDown) UpLink

func (m *MarkDown) UpLink() *MarkDown

UpLink creates and appends a link to the top of the file

func (*MarkDown) Write

func (m *MarkDown) Write(str string) *MarkDown

Write appends a string to the md document

func (*MarkDown) WriteLineBreak

func (m *MarkDown) WriteLineBreak() *MarkDown

WriteLineBreak appends a empty line to the md document

func (*MarkDown) Writeln

func (m *MarkDown) Writeln(str string) *MarkDown

Writeln appends a newline appended string to the md document