xyproto/splash

:ocean: Syntax highlight code embedded in HTML with a splash of color. Also includes the auto-updated Chroma style gallery.

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

• Version: 1.1.6
• License: BSD-3
• Author: Alexander F. Rødseth <[email protected]>

splash's Issues

Update cmd/selfupdate to fetch a more accurate list of styles

I suspect that the Chroma package uses different names than what is being generated and placed into cmd/gendoc/styles.go, because the generated style gallery doesn't look quite right. Several of the themes look the same, with a black background and some cyan text: https://xyproto.github.io/splash/docs/all.html

Give it 24 hours and check if the web page looks any better.

Gallery preview only displays two themes

As of now the Chroma Style Gallery
is only displaying xcode and xcode dark.

Looking at the commit history it seems like the problem comes and goes with every dependency update somehow.

Add comments to the longer examples

It would be nice if the longer examples included some form of comment (so we can see what that looks like)

All themes on a single page

Hello,

I was wondering if you can create just a single page that shows all the themes..

It would help someone quickly review all the themes. One example that I have in mind is a theme demo page for Pygments syntax highlighting: https://help.farbox.com/pygments.html.

Catpuccin styles missing from Gallery

From: alecthomas/chroma#719

Repro

1. Go here: https://xyproto.github.io/splash/docs/all.html
2. Search for catpuccin

Current result

Not found

Expected result

Four Catpuccin flavors should be on that page since it's in the Chroma source code:
https://github.com/alecthomas/chroma/tree/master/styles

Missing themes from Chroma master

Hi! There are a few themes missing from https://xyproto.github.io/splash/docs/ that can be found in https://github.com/alecthomas/chroma/tree/master/styles; could that be updated? I can put up a PR too, if you're happy for me to.

Themes preview: Background color unset + foreground color set = potentially unreadable titles

The theme preview page ( https://xyproto.github.io/splash/docs/all.html ) sets foreground color for the theme names, but does not set a background color, which then uses each user's browser's configured fallback color scheme for pages which don't set those values.

The combination of a hard-coded foreground with an unknown user-dependent background makes legibility a gamble.

For example, if a Firefox user goes to Preferences, clicks Manage Colors, and sets the fallback scheme to light-on-dark (never overriding a page's set colors), the appearance of the theme preview page becomes dark-on-dark: