syntax

Documentation

Overview

Package syntax contains components to perform syntax highlighting

Index

• type CodeBlock
  • func NewCodeBlock() CodeBlock
  • func (code CodeBlock) Content() ([]byte, string)
  • func (code CodeBlock) Exists() bool
• type Highlighter
• type Pygmentize
  • func (h Pygmentize) Highlight(text []byte, lang string) ([]byte, error)

Types

type CodeBlock

type CodeBlock struct {
	Lang  string
	Block *bytes.Buffer
}

CodeBlock is a ``` fenced block of code that will be syntax highlighted

func NewCodeBlock

func NewCodeBlock() CodeBlock

func (CodeBlock) Content

func (code CodeBlock) Content() ([]byte, string)

func (CodeBlock) Exists

func (code CodeBlock) Exists() bool

type Highlighter

type Highlighter interface {
	Highlight(text []byte, lang string) ([]byte, error)
}

Highlighter is the interface that syntax highlighters must implement

type Pygmentize

type Pygmentize struct{}

Pygmentize uses the external "pygmentize" command. Pygmentize must be installed on the executing machine: http://pygments.org/ pip install Pygments

func (Pygmentize) Highlight

func (h Pygmentize) Highlight(text []byte, lang string) ([]byte, error)