markdown

Documentation

Overview

Package markdown provides an markdown bubble which can render markdown in a pretty manor.

Index

• func RenderMarkdown(width int, content string) (string, error)
• type Bubble
  • func New(active, borderless bool, borderColor lipgloss.AdaptiveColor) Bubble
  • func (b *Bubble) GotoTop()
  • func (b Bubble) Init() tea.Cmd
  • func (b *Bubble) SetBorderColor(color lipgloss.AdaptiveColor)
  • func (b *Bubble) SetBorderless(borderless bool)
  • func (b *Bubble) SetFileName(filename string) tea.Cmd
  • func (b *Bubble) SetIsActive(active bool)
  • func (b *Bubble) SetSize(w, h int) tea.Cmd
  • func (b Bubble) Update(msg tea.Msg) (Bubble, tea.Cmd)
  • func (b Bubble) View() string

Functions

func RenderMarkdown

func RenderMarkdown(width int, content string) (string, error)

RenderMarkdown renders the markdown content with glamour.

Types

type Bubble

type Bubble struct {
	Viewport    viewport.Model
	BorderColor lipgloss.AdaptiveColor
	Active      bool
	Borderless  bool
	FileName    string
	ImageString string
}

Bubble represents the properties of a code bubble.

func New

func New(active, borderless bool, borderColor lipgloss.AdaptiveColor) Bubble

New creates a new instance of markdown.

func (*Bubble) GotoTop

func (b *Bubble) GotoTop()

GotoTop jumps to the top of the viewport.

func (Bubble) Init

func (b Bubble) Init() tea.Cmd

Init initializes the code bubble.

func (*Bubble) SetBorderColor

func (b *Bubble) SetBorderColor(color lipgloss.AdaptiveColor)

SetBorderColor sets the current color of the border.

func (*Bubble) SetBorderless

func (b *Bubble) SetBorderless(borderless bool)

SetBorderless sets weather or not to show the border.

func (*Bubble) SetFileName

func (b *Bubble) SetFileName(filename string) tea.Cmd

SetFileName sets current file to render, this returns a cmd which will render the text.

func (*Bubble) SetIsActive

func (b *Bubble) SetIsActive(active bool)

SetIsActive sets if the bubble is currently active.

func (*Bubble) SetSize

func (b *Bubble) SetSize(w, h int) tea.Cmd

SetSize sets the size of the bubble.

func (Bubble) Update

func (b Bubble) Update(msg tea.Msg) (Bubble, tea.Cmd)

Update handles updating the UI of a code bubble.

func (Bubble) View

func (b Bubble) View() string

View returns a string representation of the markdown bubble.