d2

Documentation

Overview

Package used to render d2 graph with goldmark.

Copied from https://github.com/FurqanSoftware/goldmark-d2 and updated.

Index

• Variables
• type Block
  • func (n *Block) Dump(source []byte, level int)
  • func (n *Block) IsBlank(source []byte) bool
  • func (n *Block) Kind() ast.NodeKind
• type CompileOptions
• type Extender
  • func (e *Extender) Extend(m goldmark.Markdown)
• type HTMLRenderer
  • func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
  • func (r *HTMLRenderer) Render(w util.BufWriter, src []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
• type RenderOptions
• type Transformer
  • func (s *Transformer) Transform(doc *ast.Document, reader text.Reader, _ parser.Context)

Variables

var KindBlock = ast.NewNodeKind("Block")

Types

type Block

type Block struct {
	ast.BaseBlock
}

func (*Block) Dump

func (n *Block) Dump(source []byte, level int)

func (*Block) IsBlank

func (n *Block) IsBlank(source []byte) bool

func (*Block) Kind

func (n *Block) Kind() ast.NodeKind

type CompileOptions

type CompileOptions d2lib.CompileOptions

type Extender

type Extender struct {
	CompileOptions
	RenderOptions
}

func (*Extender) Extend

func (e *Extender) Extend(m goldmark.Markdown)

type HTMLRenderer

type HTMLRenderer struct {
	CompileOptions
	RenderOptions
}

func (*HTMLRenderer) RegisterFuncs

func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

func (*HTMLRenderer) Render

func (r *HTMLRenderer) Render(
	w util.BufWriter,
	src []byte,
	node ast.Node,
	entering bool,
) (ast.WalkStatus, error)

type RenderOptions

type RenderOptions d2svg.RenderOpts

type Transformer

type Transformer struct {
}

func (*Transformer) Transform

func (s *Transformer) Transform(doc *ast.Document, reader text.Reader, _ parser.Context)