thumbnail

Documentation

Overview

Package thumbnail automatically generates thumbnails for a variety of common image formats and saves them to a user-configurable path.

Index

• type Namer
• type Style
• type Thumbnail
  • func New() *Thumbnail
  • func (*Thumbnail) Initialize(context *goldsmith.Context) error
  • func (*Thumbnail) Name() string
  • func (self *Thumbnail) Namer(namer Namer) *Thumbnail
  • func (self *Thumbnail) Process(context *goldsmith.Context, inputFile *goldsmith.File) error
  • func (self *Thumbnail) Size(dims int) *Thumbnail
  • func (self *Thumbnail) Style(style Style) *Thumbnail

Types

type Namer

type Namer func(string, int) string

Namer callback function builds thumbnail file paths based on the original file path. An empty path can be returned if a thumbnail should not be generated for the current file.

type Style

type Style int

Desired thumbnailing styles.

const (
	Fit Style = iota
	Crop
	Pad
)

type Thumbnail

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

Thumbnail chainable context.

func New

func New() *Thumbnail

New creates a new instance of the Thumbnail plugin.

func (*Thumbnail) Initialize

func (*Thumbnail) Initialize(context *goldsmith.Context) error

func (*Thumbnail) Name

func (*Thumbnail) Name() string

func (*Thumbnail) Namer

func (self *Thumbnail) Namer(namer Namer) *Thumbnail

Namer sets the callback used to build paths for thumbnail files. Default naming appends "-thumb" to the path and changes extension to PNG, for example "file.jpg" becomes "file-thumb.png".

func (*Thumbnail) Process

func (self *Thumbnail) Process(context *goldsmith.Context, inputFile *goldsmith.File) error

func (*Thumbnail) Size

func (self *Thumbnail) Size(dims int) *Thumbnail

Size sets the desired maximum pixel size of generated thumbnails (default: 128).

func (*Thumbnail) Style

func (self *Thumbnail) Style(style Style) *Thumbnail

Style sets the desired thumbnailing style.