summaryrefslogtreecommitdiff
path: root/src/post/preprocess.go
blob: 2f3e091af4a0f5bb4cf75bd270632f6f0b6b143d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
package post

// PreprocessFunctions are functions which can be used by posts themselves to
// interleave dynamic content into their bodies.
type PreprocessFunctions interface {
	// Image returns a string which should be inlined into the post body in
	// order to render an image.
	//
	// The first argument to Image _must_ be the ID of an image asset. The
	// second argument _may_ be a description of the image which will be used as
	// alt text, or possibly displayed to the user with the image.
	Image(args ...string) (string, error)
}