README
¶
goldmark-ruby
goldmark-ruby is an extension for the goldmark that parses DenDenMarkdown style rubys (like {漢字|かんじ}).
This extension has nothing to do with the original authors of DenDenMarkdown.
Installation
go get github.com/mi759/goldmark-ruby
Usage
import (
"bytes"
"fmt"
ruby "github.com/mi759/goldmark-ruby"
"github.com/yuin/goldmark"
)
func main() {
markdown := goldmark.New(
goldmark.WithExtensions(
ruby.Ruby,
),
)
source := `ああ、{素晴|すば}らしき{新世界|しん|せ|かい}！`
var buf bytes.Buffer
err := markdown.Convert([]byte(source), &buf)
if err != nil {
panic(err)
}
fmt.Print(buf.String())
}
Options
Options for the extension
| Option | Description |
|---|---|
RpOpen |
Opening ruby fallback parenthesis, i.e. text for <rp> element before <rt> element. |
RpClose |
Closing ruby fallback parenthesis, i.e. text for <rp> element after <rt> element. |
License
MIT
Documentation
¶
Index ¶
- Variables
- type RubyChild
- type RubyExtender
- type RubyHTMLRenderer
- func (r *RubyHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
- func (r *RubyHTMLRenderer) RenderRubyChild(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
- func (r *RubyHTMLRenderer) RenderRubyParent(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
- type RubyParent
- type RubyParser
Constants ¶
This section is empty.
Variables ¶
var KindRubyChild = gast.NewNodeKind("RubyChild")
var KindRubyParent = gast.NewNodeKind("RubyParent")
var Ruby = &RubyExtender{rpOpen: "", rpClose: ""}
Ruby is an extension that allow you to use various ruby expressions.
Functions ¶
This section is empty.
Types ¶
type RubyChild ¶
type RubyChild struct {
gast.BaseInline
BaseText []byte // BaseText is the text to be annotated.
RubyText []byte // RubyText is the annotation.
}
RubyChild node has the actual information of the ruby.
func NewRubyChild ¶
NewRubyChild returns a new RubyChild node.
type RubyExtender ¶
type RubyExtender struct {
// contains filtered or unexported fields
}
func (*RubyExtender) Extend ¶
func (e *RubyExtender) Extend(m goldmark.Markdown)
Extend implements goldmark.Extender.
type RubyHTMLRenderer ¶
type RubyHTMLRenderer struct {
RpOpen string // RpOpen is text for <rp> element before <rt> element.
RpClose string // RpClose is text for <rp> element after <rt> element.
}
func (*RubyHTMLRenderer) RegisterFuncs ¶
func (r *RubyHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs. It tells goldmark which render function to call when it encounters ruby nodes in the AST.
func (*RubyHTMLRenderer) RenderRubyChild ¶
func (r *RubyHTMLRenderer) RenderRubyChild(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
RenderRubyChild renders the provided RubyChild node.
func (*RubyHTMLRenderer) RenderRubyParent ¶
func (r *RubyHTMLRenderer) RenderRubyParent(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
RenderRubyParent renders the provided RubyParent node.
type RubyParent ¶
type RubyParent struct {
gast.BaseInline
}
RubyParent node holds RubyChild node(s). It itself has no special field.
func (*RubyParent) Dump ¶
func (n *RubyParent) Dump(source []byte, level int)
Dump dumps the RubyParent node to stdout for debugging.
Source Files