Documentation ¶
Overview ¶
Package highlight provides an extension to the Goldmark Markdown Parser which adds parsing / rendering capabilities for rendering highlighted text.
Highlighted text is denoted by an opening and closing pair of equals signs e.g. `==this text is highlighted==` source text renders into `<p><mark>this text is highlighted</mark></p>`.
See example_test.go in this package for a minimal example how to integrate this module into your Goldmark parser/renderer.
Example ¶
package main import ( "bytes" "fmt" "github.com/yuin/goldmark" highlight "github.com/zuern/goldmark-highlight" ) func main() { // Create a combined parser / renderer which understands highlight syntax. md := goldmark.New( goldmark.WithExtensions( &highlight.Extender{}, ), ) markdown := []byte("==this is some highlighted text==") var buffer bytes.Buffer _ = md.Convert(markdown, &buffer) fmt.Println(buffer.String()) }
Output: <p><mark>this is some highlighted text</mark></p>
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var Kind = ast.NewNodeKind("Highlight")
Kind is the ast.NodeKind for *Highlight AST nodes.
Functions ¶
This section is empty.
Types ¶
type Extender ¶
type Extender struct{}
Extender implements the goldmark Extender interface and extends goldmark.Markdown to understand highlighting syntax.
type Highlight ¶
type Highlight struct { ast.BaseInline Level int }
A Highlight ast.Node whose contents is highlighted.
type Parser ¶
type Parser struct{}
Parser for parsing highlight markdown into a *Highlight ast.Node.
type Renderer ¶
type Renderer struct{}
Renderer renders a *Highlight ast.Node into HTML.
func (*Renderer) RegisterFuncs ¶
func (r *Renderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RendererFuncs registers NodeRendererFuncs to given NodeRendererFuncRegisterer.