texthtml

Documentation

Overview

Package texthtml formats text files to HTML.

Index

• func Format(text []byte, cfg Config) (html []byte)
• type Config
• type Selection
  • func Spans(spans ...Span) Selection
• type Span

Functions

func Format

func Format(text []byte, cfg Config) (html []byte)

Format formats text to HTML according to the configuration cfg.

Types

type Config

type Config struct {
	Line       int       // if >= 1, number lines beginning with number Line, with <span class="ln">
	GoComments bool      // mark comments in Go text with <span class="comment">
	Playground bool      // format for playground sample
	Highlight  string    // highlight matches for this regexp with <span class="highlight">
	HL         string    // highlight lines that end with // HL (x/tools/present convention)
	Selection  Selection // mark selected spans with <span class="selection">
	AST        ast.Node  // link uses to declarations, assuming text is formatting of AST
	OldDocs    bool      // emit links to ?m=old docs
}

A Config configures how to format text as HTML.

type Selection

type Selection func() Span

A Selection is an "iterator" function returning a text span. Repeated calls to a selection return consecutive, non-overlapping, non-empty spans, followed by an infinite sequence of empty spans. The first empty span marks the end of the selection.

func Spans

func Spans(spans ...Span) Selection

Spans is a helper function to make a Selection from a slice of spans. Empty spans are discarded.

type Span

type Span struct {
	Start, End int
}

A Span describes a text span [start, end). The zero value of a Span is an empty span.