prism

README

Prism

Create beautiful images of your source code directly from your terminal.

Installation

Precompiled prism binaries can be found at releases page.

Instructions below show how to build prism from sources.

go install github.com/mrmarble/prism/cmd/prism@latest # or target a specific version @v0.1.0

Usage

Be sure prism executable is under your $PATH.

Usage of prism: prism [input file] [args...] Run prism without arguments to get help output.

Flags:
  -h, --help                  Show context-sensitive help.
  -l, --lang=STRING           Language to parse.
  -o, --output="prism.png"    Output file name
      --version               Print version information and quit
      --header                Display header
      --lines=STRING          Specify a range of lines instead of reading the whole file. Ex: 10-20
  -n, --numbers               Display line numbers
  -r, --relative              Use relative numbers. Needs --lines and --numbers

Supported languages

See languages for a list of implemented languages.

Documentation

Index

• type Context
  • func NewContext() *Context
  • func (ctx *Context) EncodePNG(code string, writer io.Writer, options Options) error
  • func (ctx *Context) SavePNG(code string, output string, options Options) error
  • func (ctx *Context) SetFontFace(path string, points float64) error
  • func (ctx *Context) SetLanguage(lang tokenizer.Language)
  • func (ctx *Context) SetTheme(theme themer.Theme)
• type Options
  • func (o *Options) Apply(dc *gg.Context, ctx *Context)
• type Range
  • func (r *Range) Parse(lines string) error

Types

type Context

type Context struct {
	// contains filtered or unexported fields
}

func NewContext

func NewContext() *Context

func (*Context) EncodePNG

func (ctx *Context) EncodePNG(code string, writer io.Writer, options Options) error

func (*Context) SavePNG

func (ctx *Context) SavePNG(code string, output string, options Options) error

func (*Context) SetFontFace

func (ctx *Context) SetFontFace(path string, points float64) error

func (*Context) SetLanguage

func (ctx *Context) SetLanguage(lang tokenizer.Language)

func (*Context) SetTheme

func (ctx *Context) SetTheme(theme themer.Theme)

type Options

type Options struct {
	LineNumbers bool
	Header      bool
	Relative    bool
	Range       Range
}

func (*Options) Apply

func (o *Options) Apply(dc *gg.Context, ctx *Context)

type Range

type Range struct {
	Start int
	End   int
}

func (*Range) Parse

func (r *Range) Parse(lines string) error