xyproto / splash

:ocean: Syntax highlight code embedded in HTML with a splash of color. Also includes the auto-updated Chroma style gallery.
https://xyproto.github.io/splash/docs/
BSD 3-Clause "New" or "Revised" License
29 stars 4 forks source link
chroma css gallery-page go highlighting html syntax syntax-highlighting

Splash

Syntax highlight code embedded in HTML with a splash of color by using the chroma package.

The generated output is tested by visual inspection in Chromium, Midori and Netsurf.

Example usage

package main

import (
    "os"

    "github.com/xyproto/splash"
)

func main() {
    // Read "input.html"
    inputHTML, err := os.ReadFile("input.html")
    if err != nil {
        panic(err)
    }

    // Highlight the source code in the HTML document with the monokai style
    outputHTML, err := splash.Splash(inputHTML, "monokai")
    if err != nil {
        panic(err)
    }

    // Write the highlighted HTML to "output.html"
    if err := os.WriteFile("output.html", outputHTML, 0644); err != nil {
        panic(err)
    }
}

Available syntax highlighting styles

See the Style Gallery for a full overview of available styles and how they may appear.

General information