render

package

v0.2.0 Latest Latest Go to latest Published: Feb 12, 2024 License: MIT Imports: 35 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Bornholm/amatl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func HTML() *cli.Command
func HTMLTransformer(funcs ...HTMLTransformerOptionFunc) pipeline.Transformer
func Markdown() *cli.Command
func MarkdownTransformer(funcs ...MarkdownTransformerOptionFunc) pipeline.Transformer
func PDF() *cli.Command
func PDFTransformer(funcs ...PDFTransformerOptionFunc) pipeline.Transformer
func Root() *cli.Command
func TemplateTransformer(funcs ...TemplateTransformerOptionFunc) pipeline.Transformer
func ToggleableTransformer(t pipeline.Transformer, enabled bool) pipeline.Transformer
type HTMLTransformerOptionFunc
- func WithLayoutURL(layoutURL string) HTMLTransformerOptionFunc
- func WithLayoutVars(vars map[string]any) HTMLTransformerOptionFunc
- func WithMarkdownTransformerOptions(funcs ...MarkdownTransformerOptionFunc) HTMLTransformerOptionFunc
type HTMLTransformerOptions
- func NewHTMLTransformerOptions(funcs ...HTMLTransformerOptionFunc) *HTMLTransformerOptions
type MarkdownTransformerOptionFunc
- func WithSourceURL(sourceURL *url.URL) MarkdownTransformerOptionFunc
- func WithToc(enabled bool) MarkdownTransformerOptionFunc
type MarkdownTransformerOptions
- func NewMarkdownTransformerOptions(funcs ...MarkdownTransformerOptionFunc) *MarkdownTransformerOptions
type PDFTransformerOptionFunc
- func WithMarginBottom(margin float64) PDFTransformerOptionFunc
- func WithMarginLeft(margin float64) PDFTransformerOptionFunc
- func WithMarginRight(margin float64) PDFTransformerOptionFunc
- func WithMarginTop(margin float64) PDFTransformerOptionFunc
- func WithScale(scale float64) PDFTransformerOptionFunc
type PDFTransformerOptions
- func NewPDFTransformerOptions(funcs ...PDFTransformerOptionFunc) *PDFTransformerOptions
type TemplateTransformerOptionFunc
- func WithFuncs(funcs template.FuncMap) TemplateTransformerOptionFunc
- func WithVars(vars map[string]any) TemplateTransformerOptionFunc
type TemplateTransformerOptions
- func NewTemplateTransformerOptions(funcs ...TemplateTransformerOptionFunc) *TemplateTransformerOptions

Constants ¶

View Source

const (
	DefaultPDFMargin float64 = 1
	DefaultPDFScale  float64 = 1
)

Variables ¶

This section is empty.

Functions ¶

func HTML ¶

func HTML() *cli.Command

func HTMLTransformer ¶

func HTMLTransformer(funcs ...HTMLTransformerOptionFunc) pipeline.Transformer

func Markdown ¶

func Markdown() *cli.Command

func MarkdownTransformer ¶

func MarkdownTransformer(funcs ...MarkdownTransformerOptionFunc) pipeline.Transformer

func PDF ¶

func PDF() *cli.Command

func PDFTransformer ¶

func PDFTransformer(funcs ...PDFTransformerOptionFunc) pipeline.Transformer

func Root ¶

func Root() *cli.Command

func TemplateTransformer ¶

func TemplateTransformer(funcs ...TemplateTransformerOptionFunc) pipeline.Transformer

func ToggleableTransformer ¶

func ToggleableTransformer(t pipeline.Transformer, enabled bool) pipeline.Transformer

Types ¶

type HTMLTransformerOptionFunc ¶

type HTMLTransformerOptionFunc func(opts *HTMLTransformerOptions)

func WithLayoutURL ¶

func WithLayoutURL(layoutURL string) HTMLTransformerOptionFunc

func WithLayoutVars ¶

func WithLayoutVars(vars map[string]any) HTMLTransformerOptionFunc

func WithMarkdownTransformerOptions ¶

func WithMarkdownTransformerOptions(funcs ...MarkdownTransformerOptionFunc) HTMLTransformerOptionFunc

type HTMLTransformerOptions ¶

type HTMLTransformerOptions struct {
	*MarkdownTransformerOptions
	LayoutURL  string
	LayoutVars map[string]any
}

func NewHTMLTransformerOptions ¶

func NewHTMLTransformerOptions(funcs ...HTMLTransformerOptionFunc) *HTMLTransformerOptions

type MarkdownTransformerOptionFunc ¶

type MarkdownTransformerOptionFunc func(opts *MarkdownTransformerOptions)

func WithSourceURL ¶

func WithSourceURL(sourceURL *url.URL) MarkdownTransformerOptionFunc

func WithToc ¶

func WithToc(enabled bool) MarkdownTransformerOptionFunc

type MarkdownTransformerOptions ¶

type MarkdownTransformerOptions struct {
	SourceURL *url.URL
	WithToc   bool
}

func NewMarkdownTransformerOptions ¶

func NewMarkdownTransformerOptions(funcs ...MarkdownTransformerOptionFunc) *MarkdownTransformerOptions

type PDFTransformerOptionFunc ¶

type PDFTransformerOptionFunc func(opts *PDFTransformerOptions)

func WithMarginBottom ¶

func WithMarginBottom(margin float64) PDFTransformerOptionFunc

func WithMarginLeft ¶

func WithMarginLeft(margin float64) PDFTransformerOptionFunc

func WithMarginRight ¶

func WithMarginRight(margin float64) PDFTransformerOptionFunc

func WithMarginTop ¶

func WithMarginTop(margin float64) PDFTransformerOptionFunc

func WithScale ¶

func WithScale(scale float64) PDFTransformerOptionFunc

type PDFTransformerOptions ¶

type PDFTransformerOptions struct {
	MarginTop    float64
	MarginLeft   float64
	MarginRight  float64
	MarginBottom float64
	Scale        float64
}

func NewPDFTransformerOptions ¶

func NewPDFTransformerOptions(funcs ...PDFTransformerOptionFunc) *PDFTransformerOptions

type TemplateTransformerOptionFunc ¶

type TemplateTransformerOptionFunc func(opts *TemplateTransformerOptions)

func WithFuncs ¶

func WithFuncs(funcs template.FuncMap) TemplateTransformerOptionFunc

func WithVars ¶

func WithVars(vars map[string]any) TemplateTransformerOptionFunc

type TemplateTransformerOptions ¶

type TemplateTransformerOptions struct {
	Vars  map[string]any
	Funcs template.FuncMap
}

func NewTemplateTransformerOptions ¶

func NewTemplateTransformerOptions(funcs ...TemplateTransformerOptionFunc) *TemplateTransformerOptions

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL