package html

import "github.com/alecthomas/chroma/formatters/html"

Index ¶

• func StyleEntryToCSS(e chroma.StyleEntry) string
• type Formatter
• func New(options ...Option) *Formatter
• func (f *Formatter) Format(w io.Writer, style *chroma.Style, iterator chroma.Iterator) (err error)
• func (f *Formatter) WriteCSS(w io.Writer, style *chroma.Style) error
• type Option
• func BaseLineNumber(n int) Option
• func ClassPrefix(prefix string) Option
• func HighlightLines(ranges [][2]int) Option
• func LineNumbersInTable() Option
• func Standalone() Option
• func TabWidth(width int) Option
• func WithClasses() Option
• func WithLineNumbers() Option

Functions ¶

func StyleEntryToCSS ¶

func StyleEntryToCSS(e chroma.StyleEntry) string

StyleEntryToCSS converts a chroma.StyleEntry to CSS attributes.

Types ¶

type Formatter ¶

type Formatter struct {
	Classes bool // Exported field to detect when classes are being used
	// contains filtered or unexported fields
}

Formatter that generates HTML.

func New ¶

func New(options ...Option) *Formatter

New HTML formatter.

func (*Formatter) Format ¶

func (f *Formatter) Format(w io.Writer, style *chroma.Style, iterator chroma.Iterator) (err error)

func (*Formatter) WriteCSS ¶

func (f *Formatter) WriteCSS(w io.Writer, style *chroma.Style) error

WriteCSS writes CSS style definitions (without any surrounding HTML).

type Option ¶

type Option func(f *Formatter)

Option sets an option of the HTML formatter.

func BaseLineNumber ¶

func BaseLineNumber(n int) Option

BaseLineNumber sets the initial number to start line numbering at. Defaults to 1.

func ClassPrefix ¶

func ClassPrefix(prefix string) Option

ClassPrefix sets the CSS class prefix.

func HighlightLines ¶

func HighlightLines(ranges [][2]int) Option

HighlightLines higlights the given line ranges with the Highlight style.

A range is the beginning and ending of a range as 1-based line numbers, inclusive.

func LineNumbersInTable ¶

func LineNumbersInTable() Option

LineNumbersInTable will, when combined with WithLineNumbers, separate the line numbers and code in table td's, which make them copy-and-paste friendly.

func Standalone ¶

func Standalone() Option

Standalone configures the HTML formatter for generating a standalone HTML document.

func TabWidth ¶

func TabWidth(width int) Option

TabWidth sets the number of characters for a tab. Defaults to 8.

func WithClasses ¶

func WithClasses() Option

WithClasses emits HTML using CSS classes, rather than inline styles.

func WithLineNumbers ¶

func WithLineNumbers() Option

WithLineNumbers formats output with line numbers.

Source Files ¶

html.go