highlightjs

package
Version: v0.0.0-...-a7167af Latest Latest
Warning

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

Go to latest
Published: Nov 25, 2020 License: MIT, BSD-3-Clause Imports: 2 Imported by: 4

README

highlightjs

Package highlightjs provides an incomplete wrapper for Highlight.js (https://github.com/isagalaev/highlight.js), a Javascript syntax highlighter

go get -u myitcv.io/highlightjs

Documentation

Overview

Package highlightjs provides an incomplete wrapper for Highlight.js (https://github.com/isagalaev/highlight.js), a Javascript syntax highlighter

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HighlightResult

type HighlightResult struct {
	Language  string `js:"language"`
	Relevance int    `js:"relevance"`
	Value     string `js:"value"`
	// contains filtered or unexported fields
}

HighlightResult represents the result of a highlighting

func Highlight

func Highlight(lang string, source string, ignoreIllegals bool) *HighlightResult

Highlight is the core highlighting function. See documentation at http://highlightjs.readthedocs.io/en/latest/api.html#highlight-name-value-ignore-illegals-continuation

Jump to

Keyboard shortcuts

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