glamour

package

v0.4.0-beta.47 Latest Latest Go to latest Published: Feb 28, 2024 License: MIT Imports: 26 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/elseano/rundown

Documentation ¶

Overview ¶

Package renderer renders the given AST to certain formats.

Index ¶

Constants
func TestJumpRenderBlock(t *testing.T)
func TestJumpRenderHeading(t *testing.T)
func TestNormalRender(t *testing.T)
func TestRenderContext(t *testing.T)
type GlamourFlushNode
- func (n *GlamourFlushNode) Kind() goldast.NodeKind
type GlamourNodeRenderer
- func NewGlamourNodeRenderer(context *renderer.Context) *GlamourNodeRenderer
- func (r *GlamourNodeRenderer) RegisterFuncs(reg goldrenderer.NodeRendererFuncRegisterer)
type GlamourRenderer
- func NewGlamourRenderer(actualRenderer goldrenderer.Renderer, context *renderer.Context) *GlamourRenderer
- func (r *GlamourRenderer) AddOptions(opts ...goldrenderer.Option)
- func (r *GlamourRenderer) Render(w io.Writer, source []byte, n goldast.Node) error
type JumpError
- func (e JumpError) Error() string
type Rundown

Constants ¶

View Source

const WalkJump goldast.WalkStatus = 100

WalkJump indicates that the walker should jump to the next node.

Variables ¶

This section is empty.

Functions ¶

func TestJumpRenderBlock ¶

func TestJumpRenderBlock(t *testing.T)

func TestJumpRenderHeading ¶

func TestJumpRenderHeading(t *testing.T)

func TestNormalRender ¶

func TestNormalRender(t *testing.T)

func TestRenderContext ¶

func TestRenderContext(t *testing.T)

Types ¶

type GlamourFlushNode ¶

type GlamourFlushNode struct{ goldast.BaseBlock }

func (*GlamourFlushNode) Kind ¶

func (n *GlamourFlushNode) Kind() goldast.NodeKind

type GlamourNodeRenderer ¶

type GlamourNodeRenderer struct {
	Context *renderer.Context
}

func NewGlamourNodeRenderer ¶

func NewGlamourNodeRenderer(context *renderer.Context) *GlamourNodeRenderer

func (*GlamourNodeRenderer) RegisterFuncs ¶

func (r *GlamourNodeRenderer) RegisterFuncs(reg goldrenderer.NodeRendererFuncRegisterer)

type GlamourRenderer ¶

type GlamourRenderer struct {
	Section string
	Context *renderer.Context
	// contains filtered or unexported fields
}

func NewGlamourRenderer ¶

func NewGlamourRenderer(actualRenderer goldrenderer.Renderer, context *renderer.Context) *GlamourRenderer

NewRenderer returns a new Renderer with given options.

func (*GlamourRenderer) AddOptions ¶

func (r *GlamourRenderer) AddOptions(opts ...goldrenderer.Option)

func (*GlamourRenderer) Render ¶

func (r *GlamourRenderer) Render(w io.Writer, source []byte, n goldast.Node) error

Render will individually render the child (block) nodes. This is required as Glamour buffers block node renders until the end of the document, which means execution blocks are run before any output is seen.

type JumpError ¶

type JumpError struct {
	ToNode       goldast.Node
	ReturnToNode goldast.Node
}

func (JumpError) Error ¶

func (e JumpError) Error() string

type Rundown ¶

type Rundown struct {
	goldmark.Markdown

	Context *renderer.Context
}

Source Files ¶

View all Source files

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