README
¶
goldmark-embed
goldmark-embed is based on 13rac1's extension for the goldmark library that extends
the Markdown ![]() image embed syntax to support additional media formats.
Supports YouTube and Vimeo links.
Demo
This markdown:
# Hello goldmark-embed for YouTube
# Hello goldmark-embed for Vimeo
Becomes this HTML:
<h1>Hello goldmark-embed for Youtube</h1>
<p><iframe width="560" height="315" src="https://www.youtube.com/embed/dQw4w9WgXcQ" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p>
<h1>Hello goldmark-embed for Vimeo</h1>
<p><iframe src="https://player.vimeo.com/video/148751763?&badge=0&autopause=0&player_id=0&app_id=58479" width="724" height="404" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe></p>
Installation
go get github.com/PaperPrototype/goldmark-embed
Usage
markdown := goldmark.New(
goldmark.WithExtensions(
embed.New(),
),
)
var buf bytes.Buffer
if err := markdown.Convert([]byte(source), &buf); err != nil {
panic(err)
}
// output html
fmt.Print(buf)
}
TODO
- Embed Options
- Additional Data Sources
License
MIT
Authors
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var KindVimeo = ast.NewNodeKind("Vimeo")
KindVimeo is a NodeKind of the Vimeo node.
var KindYouTube = ast.NewNodeKind("YouTube")
KindYouTube is a NodeKind of the YouTube node.
Functions ¶
func NewHTMLRenderer ¶
func NewHTMLRenderer() renderer.NodeRenderer
NewHTMLRenderer builds a new HTMLRenderer with given options and returns it.
Types ¶
type HTMLRenderer ¶
type HTMLRenderer struct{}
HTMLRenderer struct is a renderer.NodeRenderer implementation for the extension.
func (*HTMLRenderer) RegisterFuncs ¶
func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs.
type Option ¶
type Option func(*embedExtension)
Option is a functional option type for this extension.
type Vimeo ¶
Vimeo struct represents a Vimeo Video embed of the markdown text.
type YouTube ¶
YouTube struct represents a YouTube Video embed of the Markdown text.
func NewYouTube ¶
NewYouTube returns a new YouTube node.
Source Files