Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mermaid

package module

Go to main page

Versions in this module

v0

v0.5.0

Nov 4, 2023

Changes in this version

+ var DefaultCLI = MMDC("")

type CLI

+ CommandContext func(context.Context, ...string) *exec.Cmd

+ type CLICompiler struct

+ CLI CLI

+ Theme string

+ func (d *CLICompiler) Compile(ctx context.Context, req *CompileRequest) (_ *CompileResponse, err error)

type ClientRenderer

+ MermaidURL string

+ type CompileRequest struct

+ Source string

+ type CompileResponse struct

+ SVG string

+ type Compiler interface

+ Compile func(context.Context, *CompileRequest) (*CompileResponse, error)

type Extender

+ CLI CLI

+ Compiler Compiler

+ MermaidURL string

type ServerRenderer

+ Compiler Compiler

v0.4.0

Mar 24, 2023

Changes in this version

type ClientRenderer

+ ContainerTag string

type Extender

+ ContainerTag string

type ServerRenderer

+ ContainerTag string

v0.3.0

Dec 20, 2022

Changes in this version

+ var DefaultMMDC = new(defaultMMDC)

+ var Kind = ast.NewNodeKind("MermaidBlock")

+ var ScriptKind = ast.NewNodeKind("MermaidScriptBlock")

+ type Block struct

+ func (*Block) IsRaw() bool

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

+ func (b *Block) Dump(src []byte, level int)

+ type CLI struct

+ Path string

+ func (c *CLI) Command(args ...string) *exec.Cmd

+ type ClientRenderer struct

+ MermaidJS string

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

+ func (r *ClientRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

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

+ type Extender struct

+ MMDC MMDC

+ MermaidJS string

+ NoScript bool

+ RenderMode RenderMode

+ Theme string

+ func (e *Extender) Extend(md goldmark.Markdown)

+ type MMDC interface

+ Command func(args ...string) *exec.Cmd

+ type RenderMode int

+ const RenderModeAuto

+ const RenderModeClient

+ const RenderModeServer

+ func (i RenderMode) String() string

+ type ScriptBlock struct

+ func (*ScriptBlock) IsRaw() bool

+ func (*ScriptBlock) Kind() ast.NodeKind

+ func (b *ScriptBlock) Dump(src []byte, level int)

+ type ServerRenderer struct

+ MMDC MMDC

+ Theme string

+ func (r *ServerRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

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

+ type Transformer struct

+ NoScript bool

+ func (t *Transformer) Transform(doc *ast.Document, reader text.Reader, pctx parser.Context)