goldmark-emoji

goldmark-emoji is an extension for goldmark v2 that parses :joy: style emojis.

Compatiblity

github.com/yuin/goldmark-emoji/v2 is compatible with goldmark(v2).

use github.com/yuin/goldmark-meta for goldmark(v1).

Installation

go get github.com/yuin/goldmark-emoji/v2

Usage

import (
    "bytes"
    "fmt"

    "github.com/yuin/goldmark-emoji/v2"
    "github.com/yuin/goldmark/v2/parser"
    "github.com/yuin/goldmark/v2/renderer/html"
)

func main() {
    p := parser.New(parser.WithExtensions(emoji.Parser))
    r := html.New(html.WithExtensions(emoji.HTMLRenderer))
    source := []byte(`Joy :joy:`)
    doc := p.Parse(source)
    var buf bytes.Buffer
    if err := r.Render(&buf, source, doc); err != nil {
        panic(err)
    }
    fmt.Print(buf.String())
}

With options:

p := parser.New(parser.WithExtensions(
    emoji.NewParser(emoji.WithEmojis(myEmojis)),
))
r := html.New(html.WithExtensions(
    emoji.NewHTMLRenderer(emoji.WithRenderingMethod(emoji.Twemoji)),
))

See emoji_test.go for detailed usage.

Options

goldmark/v2 separates parser and renderer extensions, so options are split accordingly.

Parser options (passed to NewParser):

Renderer options (passed to NewHTMLRenderer):

License

MIT

Author

Yusuke Inuzuka