README
¶
goldmark-embed
goldmark-embed is an extension for the goldmark library that extends
the Markdown ![]() image embed syntax to support additional media formats.
YouTube only at first.
Demo
This markdown:
# Hello goldmark-embed
Becomes this HTML:
<h1>Hello goldmark-embed</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>
Installation
go get github.com/13rac1/goldmark-embed
Usage
markdown := goldmark.New(
goldmark.WithExtensions(
embed.Embed,
),
)
var buf bytes.Buffer
if err := markdown.Convert([]byte(source), &buf); err != nil {
panic(err)
}
fmt.Print(buf)
}
TODO
- Embed Options
- Additional Data Sources
License
MIT
Author
Brad Erickson
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
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 YouTube ¶
YouTube struct represents a YouTube Video embed of the Markdown text.
func NewYouTube ¶
NewYouTube returns a new YouTube node.
Source Files
Click to show internal directories.
Click to hide internal directories.