markdown

README

term-markdown

This is a heavily modified version of the go-term-markdown package at https://github.com/MichaelMure/go-term-markdown so please consider using the original version.

Documentation

Index

• Constants
• func Extensions() parser.Extensions
• func NewRenderer(lineWidth int, leftPad int, opts ...Options) *renderer
• func Render(source string, lineWidth int, leftPad int) []byte
• type CellAlign
• type DitheringMode
• type Options
  • func WithImageDithering(mode DitheringMode) Options

Constants

const (
	NoDithering = DitheringMode(iota)
	DitheringWithBlocks
	DitheringWithChars
)

Functions

func Extensions

func Extensions() parser.Extensions

Extensions returns the bitmask of extensions supported by this renderer. The output of this function can be used to instantiate a new markdown parser using the `NewWithExtensions` function.

func NewRenderer

func NewRenderer(lineWidth int, leftPad int, opts ...Options) *renderer

/ NewRenderer creates a new instance of the console renderer

func Render

func Render(source string, lineWidth int, leftPad int) []byte

Types

type CellAlign

type CellAlign int

const (
	CellAlignLeft CellAlign = iota
	CellAlignRight
	CellAlignCenter
	CellAlignCopyHeader
)

type DitheringMode

type DitheringMode uint8

DitheringMode type is used for image scale dithering mode constants.

type Options

type Options func(r *renderer)

func WithImageDithering

func WithImageDithering(mode DitheringMode) Options

Dithering mode for ansimage Default is fine directly through a terminal DitheringWithBlocks is recommended if a terminal UI library is used