render

package

v1.6.69 Latest Latest Go to latest Published: Feb 3, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/project-chip/alchemy

Links

Open Source Insights

Documentation ¶

Overview ¶

Package render provides a pipeline for rendering parsed Asciidoc back into text Asciidoc

Index ¶

func Elements(cxt Target, prefix string, elementList ...asciidoc.Element) (err error)
type AttributeFilter
type Option
- func Wrap(lineLength int) Option
type RenderOptions
- func (ro RenderOptions) ToOptions() []Option
type Renderer
- func NewRenderer(options ...Option) *Renderer
- func (p Renderer) Name() string
- func (p Renderer) Process(cxt context.Context, input *pipeline.Data[*asciidoc.Document], index int32, ...) (outputs []*pipeline.Data[string], extra []*pipeline.Data[*asciidoc.Document], ...)
type Section
type Target
- func NewUnwrappedTarget(parent context.Context) Target
- func NewWrappedTarget(parent context.Context, wrapLength int) Target

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Elements ¶

func Elements(cxt Target, prefix string, elementList ...asciidoc.Element) (err error)

Types ¶

type AttributeFilter uint32

const (
	AttributeFilterNone AttributeFilter = 0
	AttributeFilterAll  AttributeFilter = math.MaxUint32
)

const (
	AttributeFilterID AttributeFilter = 1 << iota
	AttributeFilterTitle
	AttributeFilterStyle
	AttributeFilterCols
	AttributeFilterText
	AttributeFilterAlt
	AttributeFilterHeight
	AttributeFilterWidth
	AttributeFilterPDFWidth
	AttributeFilterRole
	AttributeFilterAlign
	AttributeFilterFloat
)

type Option ¶

type Option func(r *Renderer)

func Wrap ¶

func Wrap(lineLength int) Option

type RenderOptions ¶

type RenderOptions struct {
	WrapLength int `name:"wrap" default:"0" help:"the maximum length of a line" group:"Output:"`
}

func (RenderOptions) ToOptions ¶

func (ro RenderOptions) ToOptions() []Option

type Renderer ¶

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

func NewRenderer ¶

func NewRenderer(options ...Option) *Renderer

func (Renderer) Name ¶

func (p Renderer) Name() string

func (Renderer) Process ¶

func (p Renderer) Process(cxt context.Context, input *pipeline.Data[*asciidoc.Document], index int32, total int32) (outputs []*pipeline.Data[string], extra []*pipeline.Data[*asciidoc.Document], err error)

type Section ¶

type Section interface {
	GetASCIISection() *asciidoc.Section
}

type Target ¶

type Target interface {
	EnsureNewLine()
	WriteRune(r rune)
	WriteString(s string)
	String() string
	EnableWrap()
	DisableWrap()
	FlushWrap()
	StartBlock()
	EndBlock()
	Subtarget() Target
}

func NewUnwrappedTarget ¶

func NewUnwrappedTarget(parent context.Context) Target

func NewWrappedTarget ¶

func NewWrappedTarget(parent context.Context, wrapLength int) Target

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