highlight

package
v0.0.0-...-bb05487 Latest Latest
Warning

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

Go to latest
Published: Mar 31, 2026 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DetectChromaLexerByFileName

func DetectChromaLexerByFileName(fileName, fileLang string) chroma.Lexer

func RenderCodeByLexer

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

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

func RenderCodeSlowGuess

func RenderCodeSlowGuess(fileName, language, code string) (output template.HTML, lexer chroma.Lexer, lexerDisplayName string)

RenderCodeSlowGuess tries to get a lexer by file name and language first, if not found, it will try to guess the lexer by code content, which is slow (more than several hundreds of milliseconds).

func RenderFullFile

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

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

func RenderPlainText

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

RenderPlainText 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.

Jump to

Keyboard shortcuts

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