Documentation
¶
Index ¶
- func DetectChromaLexerByFileName(fileName, fileLang string) chroma.Lexer
- func RenderCodeByLexer(lexer chroma.Lexer, code string) template.HTML
- func RenderCodeSlowGuess(fileName, language, code string) (output template.HTML, lexer chroma.Lexer, lexerDisplayName string)
- func RenderFullFile(fileName, language string, code []byte) ([]template.HTML, string, error)
- func RenderPlainText(code []byte) []template.HTML
- func UnsafeSplitHighlightedLines(code template.HTML) (ret [][]byte)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderCodeByLexer ¶
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 ¶
RenderFullFile returns a slice of chroma syntax highlighted HTML lines of code and the matched lexer name
func RenderPlainText ¶
RenderPlainText returns non-highlighted HTML for code
func UnsafeSplitHighlightedLines ¶
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.