render

package
v0.23.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2025 License: MIT Imports: 50 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultPDFMargin              float64       = 1
	DefaultPDFScale               float64       = 1
	DefaultPDFTimeout             time.Duration = time.Minute
	DefaultPDFBackground          bool          = true
	DefaultPDFExecPath            string        = ""
	DefaultPDFDisplayHeaderFooter bool          = true
	DefaultPDFHeaderTemplate      string        = ``
	DefaultPDFFooterTemplate      string        = `` /* 223-byte string literal not displayed */

)

Variables

This section is empty.

Functions

func HTML 

func HTML() *cli.Command

func HTMLMiddleware added in v0.3.0 

func HTMLMiddleware(funcs ...HTMLTransformerOptionFunc) pipeline.Middleware

func Markdown 

func Markdown() *cli.Command

func MarkdownMiddleware added in v0.3.0 

func MarkdownMiddleware(funcs ...MarkdownTransformerOptionFunc) pipeline.Middleware

func NewResolvedInputSource added in v0.8.0 

func NewResolvedInputSource(ctx context.Context, urlStr string) (altsrc.InputSourceContext, error)

func NewResolverSourceFromFlagFunc added in v0.8.0 

func NewResolverSourceFromFlagFunc(flag string) func(cCtx *cli.Context) (altsrc.InputSourceContext, error)

func PDF 

func PDF() *cli.Command

func PDFMiddleware added in v0.3.0 

func PDFMiddleware(funcs ...PDFTransformerOptionFunc) pipeline.Middleware

func Root 

func Root() *cli.Command

func TemplateMiddleware added in v0.3.0 

func TemplateMiddleware(funcs ...TemplateTransformerOptionFunc) pipeline.Middleware

func ToggleableMiddleware added in v0.3.0 

func ToggleableMiddleware(t pipeline.Transformer, enabled bool) pipeline.Middleware

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 WithLinkReplacements added in v0.20.0 

func WithLinkReplacements(replacements map[string]string) MarkdownTransformerOptionFunc

func WithSourceURL added in v0.2.0 

func WithSourceURL(sourceURL *url.URL) MarkdownTransformerOptionFunc

type MarkdownTransformerOptions 

type MarkdownTransformerOptions struct {
	SourceURL        *url.URL
	LinkReplacements map[string]string
}

func NewMarkdownTransformerOptions 

func NewMarkdownTransformerOptions(funcs ...MarkdownTransformerOptionFunc) *MarkdownTransformerOptions

type PDFTransformerOptionFunc 

type PDFTransformerOptionFunc func(opts *PDFTransformerOptions)

func WithBackground added in v0.14.0 

func WithBackground(background bool) PDFTransformerOptionFunc

func WithDisplayFooterHeader added in v0.23.0 

func WithDisplayFooterHeader(displayHeaderFooter bool) PDFTransformerOptionFunc

func WithExecPath added in v0.15.0 

func WithExecPath(execPath string) PDFTransformerOptionFunc

func WithFooterTemplate added in v0.23.0 

func WithFooterTemplate(footerTemplate string) PDFTransformerOptionFunc

func WithHeaderTemplate added in v0.23.0 

func WithHeaderTemplate(headerTemplate string) PDFTransformerOptionFunc

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

func WithTimeout added in v0.11.0 

func WithTimeout(timeout time.Duration) PDFTransformerOptionFunc

type PDFTransformerOptions 

type PDFTransformerOptions struct {
	MarginTop           float64
	MarginLeft          float64
	MarginRight         float64
	MarginBottom        float64
	Scale               float64
	Background          bool
	Timeout             time.Duration
	ExecPath            string
	DisplayHeaderFooter bool
	HeaderTemplate      string
	FooterTemplate      string
}

func NewPDFTransformerOptions 

func NewPDFTransformerOptions(funcs ...PDFTransformerOptionFunc) *PDFTransformerOptions

type ParserOptions added in v0.20.0 

type ParserOptions struct {
	EmbedLinkedResources bool
	LinkReplacements     map[string]string
}

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.