highlight

package
v3.1.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 21, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Code

func Code(fileName, language, code string) (output template.HTML, lexerName string)

Code returns an HTML version of code string with chroma syntax highlighting classes and the matched lexer name

func CodeFromLexer

func CodeFromLexer(lexer chroma.Lexer, code string) template.HTML

CodeFromLexer returns a HTML version of code string with chroma syntax highlighting classes

func File

func File(fileName, language string, code []byte) ([]template.HTML, string, error)

File returns a slice of chroma syntax highlighted HTML lines of code and the matched lexer name

func NewContext

func NewContext()

NewContext loads custom highlight map from local config

func PlainText

func PlainText(code []byte) []template.HTML

PlainText returns non-highlighted HTML for code

func UnsafeSplitHighlightedLines

func UnsafeSplitHighlightedLines(code template.HTML) (ret [][]byte)

UnsafeSplitHighlightedLines splits highlighted code into lines preserving HTML tags It always includes '\n', '\n' can appear at the end of each line or in the middle of HTML tags The '\n' is necessary for copying code from web UI to preserve original code lines ATTENTION: It uses the unsafe conversion between string and []byte for performance reason DO NOT make any modification to the returned [][]byte slice items

Types

This section is empty.

Source Files

  • highlight.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL