package pipeline

Import Path
	github.com/d2lang/mathjax-go/internal/pipeline (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 3 packages

Involved Source Files

	  d pipeline.go
		Package pipeline defines the narrow contracts between the TeX parser, MathML
		tree, and SVG output stages.
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Compiler (interface)
		Compiler parses TeX into MathJax's internal MathML tree. Implementations
		must start each call with fresh macro, tag, and parser state.

		Methods (only one)
			( Compiler) Compile(tex string, display bool) (*mml.Node, error)
		Implemented By (at least one exported)
			*github.com/d2lang/mathjax-go/internal/tex.Compiler

	 type FontCacheMode uint8 (basic type)
		FontCacheMode controls SVG glyph path caching.

		As Types Of (only one)
			const FontCacheNone

	 type Options (struct)
		Options controls a single conversion.

		Fields (total 4)
			Display bool
			Em float64
			Ex float64
			FontCache FontCacheMode
		Methods (only one)
			( Options) Validate() error
				Validate rejects values for which the MathJax 3.2.2 compatibility contract
				is undefined.

		As Outputs Of (at least one exported)
			func DefaultOptions() Options
		As Inputs Of (at least 3)
			func Pipeline.Render(tex string, options Options) (string, error)
			func Typesetter.Typeset(root *mml.Node, options Options) (string, error)
			func github.com/d2lang/mathjax-go/internal/svg.(*Typesetter).Typeset(root *mml.Node, options Options) (string, error)

	 type Pipeline (struct)
		Pipeline joins independently implemented compiler and typesetter stages.
		Implementations should be immutable or allocate per-call state so Pipeline
		is safe for concurrent use.

		Fields (total 2)
			Compiler Compiler
			Typesetter Typesetter
		Methods (total 2)
			( Pipeline) Available() bool
				Available reports whether both stages are connected.

			( Pipeline) Render(tex string, options Options) (string, error)
				Render runs a single stateless conversion.


	 type Typesetter (interface)
		Typesetter lays out an inherited-attribute-complete MathML tree and emits the
		bare SVG element used by D2.

		Methods (only one)
			( Typesetter) Typeset(root *mml.Node, options Options) (string, error)
		Implemented By (at least one exported)
			*github.com/d2lang/mathjax-go/internal/svg.Typesetter


Package-Level Functions (only one)

	 func DefaultOptions() Options
		DefaultOptions reproduces html.convert(tex, {em: 16, ex: 8}) with the SVG
		output jax configured as {fontCache: "none"}.


Package-Level Constants (only one)

	const FontCacheNone FontCacheMode = 0
		FontCacheNone emits a path for every glyph occurrence. This is the only
		mode in D2's frozen MathJax component and is currently the only supported
		mathjax-go mode.

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.