markdown

Documentation

Index

• Variables
• func GetDefaultStyle(atmosConfig schema.AtmosConfiguration) ([]byte, error)
• func SplitMarkdownContent(content string) []string
• type Option
  • func WithWidth(width uint) Option
• type Renderer
  • func NewRenderer(atmosConfig schema.AtmosConfiguration, opts ...Option) (*Renderer, error)
  • func NewTerminalMarkdownRenderer(atmosConfig schema.AtmosConfiguration) (*Renderer, error)
  • func (r *Renderer) Render(content string) (string, error)
  • func (r *Renderer) RenderAscii(content string) (string, error)
  • func (r *Renderer) RenderError(title, details, suggestion string) (string, error)
  • func (r *Renderer) RenderErrorf(content string, args ...interface{}) (string, error)
  • func (r *Renderer) RenderSuccess(title, details string) (string, error)
  • func (r *Renderer) RenderWithStyle(content string, style []byte) (string, error)
  • func (r *Renderer) RenderWorkflow(content string) (string, error)

Variables

var (
	White       = "#FFFFFF"
	Purple      = "#9B51E0"
	Blue        = "#00A3E0"
	Gray        = "#4A5568"
	Green       = "#48BB78"
	Yellow      = "#ECC94B"
	Red         = "#F56565"
	LightBlue   = "#4299E1"
	BlueLight   = "#63B3ED"
	GrayLight   = "#718096"
	GrayMid     = "#A0AEC0"
	GrayDark    = "#2D3748"
	GrayBorder  = "#CBD5E0"
	OffWhite    = "#F7FAFC"
	DarkSlate   = "#1A202C"
	GreenLight  = "#68D391"
	YellowLight = "#F6E05E"
	RedLight    = "#FC8181"
)

Base colors used throughout the application

var Colors = struct {
	Primary    lipgloss.AdaptiveColor
	Secondary  lipgloss.AdaptiveColor
	Success    lipgloss.AdaptiveColor
	Warning    lipgloss.AdaptiveColor
	Error      lipgloss.AdaptiveColor
	Info       lipgloss.AdaptiveColor
	Subtle     lipgloss.AdaptiveColor
	HeaderBg   lipgloss.AdaptiveColor
	Border     lipgloss.AdaptiveColor
	Background lipgloss.AdaptiveColor
}{
	Primary:    lipgloss.AdaptiveColor{Light: Blue, Dark: Blue},
	Secondary:  lipgloss.AdaptiveColor{Light: Gray, Dark: GrayMid},
	Success:    lipgloss.AdaptiveColor{Light: Green, Dark: GreenLight},
	Warning:    lipgloss.AdaptiveColor{Light: Yellow, Dark: YellowLight},
	Error:      lipgloss.AdaptiveColor{Light: Red, Dark: RedLight},
	Info:       lipgloss.AdaptiveColor{Light: LightBlue, Dark: BlueLight},
	Subtle:     lipgloss.AdaptiveColor{Light: GrayLight, Dark: GrayMid},
	HeaderBg:   lipgloss.AdaptiveColor{Light: GrayDark, Dark: Gray},
	Border:     lipgloss.AdaptiveColor{Light: GrayBorder, Dark: Gray},
	Background: lipgloss.AdaptiveColor{Light: OffWhite, Dark: DarkSlate},
}

Colors defines the color scheme for markdown rendering

Functions

func GetDefaultStyle

func GetDefaultStyle(atmosConfig schema.AtmosConfiguration) ([]byte, error)

GetDefaultStyle returns the markdown style configuration from atmos.yaml settings or falls back to built-in defaults if not configured

func SplitMarkdownContent

func SplitMarkdownContent(content string) []string

SplitMarkdownContent splits markdown content into details and suggestion parts

Types

type Option

type Option func(*Renderer)

Option is a function that configures the renderer

func WithWidth

func WithWidth(width uint) Option

WithWidth sets the word wrap width for the renderer

type Renderer

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

Renderer is a markdown renderer using Glamour

func NewRenderer

func NewRenderer(atmosConfig schema.AtmosConfiguration, opts ...Option) (*Renderer, error)

NewRenderer creates a new markdown renderer with the given options

func NewTerminalMarkdownRenderer

func NewTerminalMarkdownRenderer(atmosConfig schema.AtmosConfiguration) (*Renderer, error)

func (*Renderer) Render

func (r *Renderer) Render(content string) (string, error)

Render renders markdown content to ANSI styled text

func (*Renderer) RenderAscii

func (r *Renderer) RenderAscii(content string) (string, error)

func (*Renderer) RenderError

func (r *Renderer) RenderError(title, details, suggestion string) (string, error)

RenderError renders an error message with specific styling

func (*Renderer) RenderErrorf

func (r *Renderer) RenderErrorf(content string, args ...interface{}) (string, error)

RenderErrorf renders an error message with specific styling

func (*Renderer) RenderSuccess

func (r *Renderer) RenderSuccess(title, details string) (string, error)

RenderSuccess renders a success message with specific styling

func (*Renderer) RenderWithStyle

func (r *Renderer) RenderWithStyle(content string, style []byte) (string, error)

RenderWithStyle renders markdown content with a specific style

func (*Renderer) RenderWorkflow

func (r *Renderer) RenderWorkflow(content string) (string, error)

RenderWorkflow renders workflow documentation with specific styling