markdown

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package markdown provides Markdown rendering for terminal output. Supports code highlighting, tables, lists, and inline styles.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Render

func Render(text string, width int) string

Render renders Markdown using default settings.

func RenderCode

func RenderCode(lang string, code string, width int, lineNumbers bool) string

RenderCode renders a code block with syntax highlighting.

Types

type CodeTheme

type CodeTheme struct {
	Keyword  lipgloss.Color
	String   lipgloss.Color
	Comment  lipgloss.Color
	Number   lipgloss.Color
	Function lipgloss.Color
	Operator lipgloss.Color
	Type     lipgloss.Color
	Variable lipgloss.Color
	Default  lipgloss.Color
}

CodeTheme defines colors for syntax highlighting.

func DefaultCodeTheme

func DefaultCodeTheme() *CodeTheme

DefaultCodeTheme returns the default code theme.

type Renderer

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

Renderer renders Markdown content to styled terminal output.

func NewRenderer

func NewRenderer(width int) *Renderer

NewRenderer creates a new Markdown renderer.

func (*Renderer) Render

func (r *Renderer) Render(text string) string

Render renders Markdown text to styled terminal output.

func (*Renderer) SetLineNumbers

func (r *Renderer) SetLineNumbers(enabled bool)

SetLineNumbers enables/disables line numbers in code blocks.

func (*Renderer) SetWidth

func (r *Renderer) SetWidth(width int)

SetWidth sets the rendering width.

Directories

Path Synopsis
Package completion provides auto-completion for commands and suggestions.
Package completion provides auto-completion for commands and suggestions.
Package list provides virtualized list rendering for large datasets.
Package list provides virtualized list rendering for large datasets.
Package markdown provides markdown rendering for terminal output.
Package markdown provides markdown rendering for terminal output.
Package spinner provides a loading spinner component.
Package spinner provides a loading spinner component.
Package textbuffer provides a multi-line text editor with cursor movement, history navigation, and auto-completion support.
Package textbuffer provides a multi-line text editor with cursor movement, history navigation, and auto-completion support.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL