README
¶
mermaid.go
mermaid.go is a library for invoking mermaid.js and getting rending result.
sequenceDiagram
Actor A as User
participant B as mermaid.go
participant C as chromedp
A ->>+ B: NewRenderEngine()
B ->>+ C: Lanch new instance of chrome and eval JS library
C -->> B:
B -->> A:
loop Render Process
A ->> B: Render()
B ->> C: mermaid.render()
C ->> B: { svg, boxModel, exceptions }
B ->> A: Result{ Svg, BoxModel Error }
end
A ->> B: Cancel()
B -->> C: Context done
C -->>- C: Shutdown chrome instance
B -->>- A:
Installation:
go get -u github.com/dreampuf/mermaid.go
Example:
An example is available here.
How to build
- Checkout the code base
git clone https://github.com/dreampuf/mermaid.go.git - Fetch the latest version of mermaid.js
curl -LO https://unpkg.com/mermaid/dist/mermaid.min.jsOr if you want a specific versioncurl -LO https://unpkg.com/mermaid@10.3.0/dist/mermaid.min.js - Test it
go test ./...
License
- mermaid.go: MIT License
- mermaid.js: MIT License
- chromedp: MIT License
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DEFAULT_PAGE = `data:text/html,<!DOCTYPE html>
<html lang="en">
<head><meta charset="utf-8"></head>
<body></body>
</html>`
View Source
var ERR_MERMAID_NOT_READY = errors.New("mermaid.js initial failed")
View Source
var SOURCE_MERMAID string
Functions ¶
This section is empty.
Types ¶
type RenderEngine ¶
type RenderEngine struct {
// contains filtered or unexported fields
}
func NewRenderEngine ¶
func NewRenderEngine(ctx context.Context, statements ...string) (*RenderEngine, error)
func (*RenderEngine) Cancel ¶
func (r *RenderEngine) Cancel()
func (*RenderEngine) RenderAsPng ¶ added in v0.0.3
func (r *RenderEngine) RenderAsPng(content string) ([]byte, *BoxModel, error)
func (*RenderEngine) RenderAsScaledPng ¶ added in v0.0.12
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.