figure

goldmark-figure

goldmark-figure is a goldmark extension to parse mardown paragraphs that start with an image into HTML <figure> elements. One nice thing is it doesn't use any new markdown syntaxes.

Example markdown source:

![Picture of Oscar.](/path/to/cat.jpg)
Awesome caption about **Oscar** the kitty.

Render result:

<figure>
    <img src="/path/to/cat.jpg" alt="Picture of Oscar." />
    <figcaption>Awesome caption about <strong>Oscar</strong> the kitty.</figcaption>
</figure>

Installation

go get github.com/mangoumbrella/goldmark-figure

Usage

import (
    "bytes"
    "fmt"

    "github.com/mangoumbrella/goldmark-figure"
    "github.com/yuin/goldmark"
)

func main() {
    markdown := goldmark.New(
        goldmark.WithExtensions(
            figure.Figure,
        ),
    )
    source := `
    ![Picture of Oscar.](/path/to/cat.jpg)
    Awesome caption about **Oscar** the kitty.
    `
    var buf bytes.Buffer
    if err := markdown.Convert([]byte(source), &buf); err != nil {
        panic(err)
    }
    fmt.Print(buf.String())
}

See figure_test.go for detailed usages.

LICENSE

MIT

Authors

Yilei Yang