markdown

Documentation

Index

• Constants
• type MarkdownBuilder
  • func NewMarkdownBuilder() *MarkdownBuilder
  • func (mb *MarkdownBuilder) AddBulletPoint(text string)
  • func (mb *MarkdownBuilder) AddCodeSnippet(code, language string)
  • func (mb *MarkdownBuilder) AddCollapsibleSection(section *MarkdownCollapsibleSection)
  • func (mb *MarkdownBuilder) AddHeader(level int, text string)
  • func (mb *MarkdownBuilder) AddNumberedPoint(number int, text string)
  • func (mb *MarkdownBuilder) AddParagraph(text string)
  • func (mb *MarkdownBuilder) Build() string
  • func (mb *MarkdownBuilder) StartCollapsibleSection(title string) *MarkdownCollapsibleSection
• type MarkdownCollapsibleSection
  • func (s *MarkdownCollapsibleSection) Builder() *MarkdownBuilder

Constants

const (
	EmojiArrowRight     = ":arrow_right:"
	EmojiWhiteCheckMark = ":white_check_mark:"
	EmojiCrossMark      = ":x:"
	EmojiLink           = ":link:"
	EmojiWarning        = ":warning:"
)

Types

type MarkdownBuilder

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

func NewMarkdownBuilder

func NewMarkdownBuilder() *MarkdownBuilder

func (*MarkdownBuilder) AddBulletPoint

func (mb *MarkdownBuilder) AddBulletPoint(text string)

AddBulletPoint adds a bullet point to the markdown document.

func (*MarkdownBuilder) AddCodeSnippet

func (mb *MarkdownBuilder) AddCodeSnippet(code, language string)

AddCodeSnippet adds a code snippet to the markdown document.

func (*MarkdownBuilder) AddCollapsibleSection

func (mb *MarkdownBuilder) AddCollapsibleSection(section *MarkdownCollapsibleSection)

AddCollapsibleSection adds a collapsible section to the markdown document.

func (*MarkdownBuilder) AddHeader

func (mb *MarkdownBuilder) AddHeader(level int, text string)

AddHeader adds a header to the markdown document.

func (*MarkdownBuilder) AddNumberedPoint

func (mb *MarkdownBuilder) AddNumberedPoint(number int, text string)

AddNumberedPoint adds a numbered point to the markdown document.

func (*MarkdownBuilder) AddParagraph

func (mb *MarkdownBuilder) AddParagraph(text string)

AddParagraph adds a paragraph to the markdown document.

func (*MarkdownBuilder) Build

func (mb *MarkdownBuilder) Build() string

func (*MarkdownBuilder) StartCollapsibleSection

func (mb *MarkdownBuilder) StartCollapsibleSection(title string) *MarkdownCollapsibleSection

StartCollapsibleSection starts a collapsible section in the markdown document.

type MarkdownCollapsibleSection

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

func (*MarkdownCollapsibleSection) Builder

func (s *MarkdownCollapsibleSection) Builder() *MarkdownBuilder