README
¶
goldmark-hashtag
goldmark-hashtag is an extension for the goldmark library to handle
#example hashtags providing a Hashtag AST type.
Demo
This markdown:
# Hello goldmark-hashtag
#example
With the default configuration, becomes this HTML:
<h1>Hello goldmark-hashtag</h1>
<p><a href="/tags/example">#example</a></p>
Installation
go get github.com/13rac1/goldmark-hashtag
Usage
markdown := goldmark.New(
goldmark.WithExtensions(
hashtag.Extension,
),
)
var buf bytes.Buffer
if err := markdown.Convert([]byte(source), &buf); err != nil {
panic(err)
}
fmt.Print(buf)
}
License
MIT
Author
Brad Erickson
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var KindHashtag = ast.NewNodeKind("Hashtag")
KindHashtag is a NodeKind of the Hashtag 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 Hashtag ¶
Hashtag struct represents a Hashtag of the Markdown text.
func NewHashtag ¶
NewHashtag returns a new Hashtag node.
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
Parser implements the goldmark parser.Parser interface
func NewParser ¶
func NewParser() *Parser
NewParser gives you back a parser that you can use to process hashtags.
func (*Parser) WithNormalizer ¶
WithNormalizer is the fluent interface for replacing the default normalizer plugin.
Source Files