2.7 KiB
syntaxhighlight
Package syntaxhighlight provides syntax highlighting for code. It currently uses a language-independent lexer and performs decently on JavaScript, Java, Ruby, Python, Go, and C.
The main AsHTML(src []byte) ([]byte, error) function outputs HTML that uses the same CSS classes as google-code-prettify, so any stylesheets for that should also work with this package.
Installation
go get -u github.com/sourcegraph/syntaxhighlight
First you should install the golang evironment, you can download it here or you can follow the getting started
Remember you should set the environment variables correctly (GOPATH and PATH)
Example usage
The function AsHTML(src []byte, options ...Option) ([]byte, error) returns an HTML-highlighted version of src. The input source code can be in any language; the lexer is language independent. An OrderedList() option can be passed to produce an <ol>...</ol>-wrapped list to display line numbers.
package syntaxhighlight_test
import (
"fmt"
"os"
"github.com/sourcegraph/syntaxhighlight"
)
func Example() {
src := []byte(`
/* hello, world! */
var a = 3;
// b is a cool function
function b() {
return 7;
}`)
highlighted, err := syntaxhighlight.AsHTML(src)
if err != nil {
fmt.Println(err)
os.Exit(1)
}
fmt.Println(string(highlighted))
// Output:
// <span class="com">/* hello, world! */</span>
// <span class="kwd">var</span> <span class="pln">a</span> <span class="pun">=</span> <span class="dec">3</span><span class="pun">;</span>
//
// <span class="com">// b is a cool function</span>
// <span class="kwd">function</span> <span class="pln">b</span><span class="pun">(</span><span class="pun">)</span> <span class="pun">{</span>
// <span class="kwd">return</span> <span class="dec">7</span><span class="pun">;</span>
// <span class="pun">}</span>
}
Contributors
Contributions are welcome! Submit a pull request on GitHub.