highlight

README

go-highlight

A Go (Golang) code syntax highlighting library. It uses automatically converted highlight.js language definitions.

Usage

package main

import "github.com/d4l3k/go-highlight"

func main() {
  highlight.Highlight("go", `
    package main

    import "fmt"

    func main() {
      fmt.Println("Duck!")
    }
  `)
  /*
    <keyword>package</keyword> main

    <keyword>import</keyword> <string>"fmt"</string>

    <keyword>func</keyword> main() {
      fmt.Println(<string>"Duck!"</string>)
    }
  */
}

Copyright

The code written by Tristan Rice is licensed under the MIT license.

The language definitions are ported from highlight.js which is licensed under the BSD licence.

Documentation

Index

• Constants
• Variables
• func Detect(code []byte) (string, error)
• func HTML(lang string, code []byte) ([]byte, error)
• func InlineHTML(lang string, code []byte) ([]byte, error)
• func Term(lang string, code []byte) ([]byte, error)

Constants

const (
	Keyword = "keyword"
	Literal = "literal"
	BuiltIn = "built_in"
)

The text highlight classes.

Variables

var Workers = 1

Workers is the number of workers to use to detect the language.

Functions

func Detect

func Detect(code []byte) (string, error)

Detect returns the detected language.

func HTML

func HTML(lang string, code []byte) ([]byte, error)

HTML highlights a piece of code in HTML <div class="highlight"><pre><code>.

func InlineHTML

func InlineHTML(lang string, code []byte) ([]byte, error)

InlineHTML highlights a piece of code in HTML <code>.

func Term

func Term(lang string, code []byte) ([]byte, error)

Term highlights a piece of code for rendering in the terminal.