synlight

Documentation

Overview

something like pygments in go written before I discovered https://github.com/alecthomas/chroma

Index

• type Lighter
  • func New(options Options) *Lighter
  • func (hl *Lighter) AddLexer(lang string, r io.Reader)
  • func (hl *Lighter) Highlight(data []byte, filename string, w io.Writer)
  • func (hl *Lighter) HighlightString(data string, filename string) string
• type Options
• type OutputFormat

Types

type Lighter

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

A syntax highlighter

func New

func New(options Options) *Lighter

Create a new highlighter. It should be reused if possible.

func (*Lighter) AddLexer

func (hl *Lighter) AddLexer(lang string, r io.Reader)

Add a new lexer to this highlighter.

func (*Lighter) Highlight

func (hl *Lighter) Highlight(data []byte, filename string, w io.Writer)

Highlight code, writing it to w.

func (*Lighter) HighlightString

func (hl *Lighter) HighlightString(data string, filename string) string

Highlight code, returning a string

type Options

type Options struct {
	Format OutputFormat
}

Options for creating a new highlighter. HTML or TTY output are supported.

type OutputFormat

type OutputFormat int

const (
	None OutputFormat = iota
	HTML
	TTY
)