mermaid

README

goldmark-mermaid

goldmark-mermaid is an extension for goldmark.

You can use mermaid to build svg image in your markdown like mume

screenshot

There are two demo(using ' instead of ′ in the code block)

1. default config

Demo1 Output1

'''go
package main

import ()

func main(){}
'''

'''mermaid
pie
    title Key elements in Product X
    "Calcium" : 42.96
    "Potassium" : 50.05
    "Magnesium" : 10.01
    "Iron" :  5
'''

1. using mermaid-svg and goldmark-highlighting extension

Demo2 Output2

'''go
package main

import ()

func main(){}
'''

'''mermaid-svg
pie
    title Key elements in Product X
    "Calcium" : 42.96
    "Potassium" : 50.05
    "Magnesium" : 10.01
    "Iron" :  5
'''

Installation

go get -u github.com/OhYee/goldmark-mermaid

License

MIT

Documentation

Overview

Package mermaid is a extension for the goldmark(http://github.com/yuin/goldmark).

This extension adds svg picture output from mermaid language using go-mermaid(https://github.com/OhYee/go-mermaid).

Index

• Variables
• func NewMermaidExtension(length int, languages ...string) goldmark.Extender
• func RenderMap(length int, languages ...string) ext.RenderMap
• type Mermaid
  • func NewMermaid(length int, languages ...string) *Mermaid
  • func (u *Mermaid) Renderer(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)

Variables

var Default = NewMermaidExtension(50, "mermaid")

Default Mermaid extension when there is no other fencedCodeBlock goldmark render extensions

Functions

func NewMermaidExtension

func NewMermaidExtension(length int, languages ...string) goldmark.Extender

NewMermaidExtension return the goldmark.Extender

func RenderMap

func RenderMap(length int, languages ...string) ext.RenderMap

RenderMap return the goldmark-fenced_codeblock_extension.RenderMap

Types

type Mermaid

type Mermaid struct {
	Languages []string

	MaxLength int
	// contains filtered or unexported fields
}

Mermaid render struct

func NewMermaid

func NewMermaid(length int, languages ...string) *Mermaid

NewMermaid initial a Mermaid struct

func (*Mermaid) Renderer

func (u *Mermaid) Renderer(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)

Renderer render function