assets

package

v0.3.9 Latest Latest Go to latest Published: Jun 8, 2026 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/livetemplate/tinkerdown

Links

Open Source Insights

Documentation ¶

Overview ¶

Package assets embeds the client JavaScript, CSS, and vendor libraries

Index ¶

Variables
func ClientFS() fs.FS
func GetChartJS() ([]byte, error)
func GetClientCSS() ([]byte, error)
func GetClientJS() ([]byte, error)
func GetMermaidJS() ([]byte, error)
func GetPicoCSS() ([]byte, error)
func GetPrismCSS() ([]byte, error)
func GetPrismJS() ([]byte, error)
func GetPrismLanguage(lang string) ([]byte, error)
func GetPrismLineHighlightCSS() ([]byte, error)
func GetPrismLineHighlightJS() ([]byte, error)
func GetPrismLineNumbersCSS() ([]byte, error)
func GetPrismLineNumbersJS() ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var SupportedPrismLanguages = map[string]bool{
	"go":         true,
	"javascript": true,
	"jsx":        true,
	"markup":     true,
	"css":        true,
	"yaml":       true,
	"json":       true,
	"bash":       true,
	"markdown":   true,
}

SupportedPrismLanguages is the whitelist of available Prism language components

Functions ¶

func ClientFS ¶

func ClientFS() fs.FS

ClientFS returns the embedded client files

func GetClientCSS ¶

func GetClientCSS() ([]byte, error)

GetClientCSS returns the browser CSS bundle

func GetClientJS ¶

func GetClientJS() ([]byte, error)

GetClientJS returns the browser JavaScript bundle

func GetMermaidJS ¶

func GetMermaidJS() ([]byte, error)

GetMermaidJS returns the Mermaid.js library

func GetPicoCSS ¶

func GetPicoCSS() ([]byte, error)

GetPicoCSS returns the Pico CSS framework

func GetPrismCSS ¶

func GetPrismCSS() ([]byte, error)

GetPrismCSS returns the vendored light Prism.js theme CSS.

func GetPrismJS ¶

func GetPrismJS() ([]byte, error)

GetPrismJS returns the Prism.js core library

func GetPrismLanguage ¶

func GetPrismLanguage(lang string) ([]byte, error)

GetPrismLanguage returns a Prism language component. The language must be in the SupportedPrismLanguages whitelist.

func GetPrismLineHighlightCSS ¶ added in v0.2.0

func GetPrismLineHighlightCSS() ([]byte, error)

GetPrismLineHighlightCSS returns the Prism Line Highlight plugin CSS.

func GetPrismLineHighlightJS ¶ added in v0.2.0

func GetPrismLineHighlightJS() ([]byte, error)

GetPrismLineHighlightJS returns the Prism Line Highlight plugin JS, vendored from prismjs@1.29.0. Used by `LANG include="..." highlight="3-5"` fences to draw an emphasis overlay on selected lines.

func GetPrismLineNumbersCSS ¶ added in v0.2.0

func GetPrismLineNumbersCSS() ([]byte, error)

GetPrismLineNumbersCSS returns the Prism Line Numbers plugin CSS.

func GetPrismLineNumbersJS ¶ added in v0.2.0

func GetPrismLineNumbersJS() ([]byte, error)

GetPrismLineNumbersJS returns the Prism Line Numbers plugin JS, which numbers lines in the gutter — used by every `LANG include="..."` block so the snippet has stable coordinates the footer label (`counter.go:13-35`) and the optional `highlight=` overlay can refer to.

Types ¶