package svg

Import Path
	github.com/alecthomas/chroma/v2/formatters/svg (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	    font_liberation_mono.go
	  d svg.go
		Package svg contains an SVG formatter.
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type FontFormat int (basic type)

		As Inputs Of (at least one exported)
			func EmbedFont(fontFamily string, font string, format FontFormat) Option
		As Types Of (total 3)
			const TRUETYPE
			const WOFF
			const WOFF2

	 type Formatter (struct)
		Formatter that generates SVG.

		Methods (only one)
			(*Formatter) Format(w io.Writer, style *chroma.Style, iterator chroma.Iterator) (err error)
		Implements (at least one exported)
			*Formatter : github.com/alecthomas/chroma/v2.Formatter
		As Outputs Of (at least one exported)
			func New(options ...Option) *Formatter

	 type Option (func)
		Option sets an option of the SVG formatter.

		As Outputs Of (at least 3)
			func EmbedFont(fontFamily string, font string, format FontFormat) Option
			func EmbedFontFile(fontFamily string, fileName string) (option Option, err error)
			func FontFamily(fontFamily string) Option
		As Inputs Of (at least one exported)
			func New(options ...Option) *Formatter


Package-Level Functions (total 5)

	 func EmbedFont(fontFamily string, font string, format FontFormat) Option
		EmbedFont embeds given base64 encoded font

	 func EmbedFontFile(fontFamily string, fileName string) (option Option, err error)
		EmbedFontFile embeds given font file

	 func FontFamily(fontFamily string) Option
		FontFamily sets the font-family.

	 func New(options ...Option) *Formatter
		New SVG formatter.

	 func StyleEntryToSVG(e chroma.StyleEntry) string
		StyleEntryToSVG converts a chroma.StyleEntry to SVG attributes.


Package-Level Variables (only one)

	  var FontLiberationMono string
		Liberation Mono as base64 encoded woff (SIL Open Font License)[https://en.wikipedia.org/wiki/Liberation_fonts]


Package-Level Constants (total 3)

	const TRUETYPE FontFormat = 2
		https://transfonter.org/formats

	const WOFF FontFormat = 0
		https://transfonter.org/formats

	const WOFF2 FontFormat = 1
		https://transfonter.org/formats

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.