ruby

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 21, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	TagOpen  = []byte("<ruby")
	TagClose = []byte("</ruby>")
)

Byte constants for HTML rendering.

Functions

func New

func New(nodes ...node.Node) *element

New Creates a new ruby element with optional child nodes Example: ruby.New(text.Text("漢字")) Renders: <ruby>漢字</ruby>

func RawText

func RawText(content string) *element

RawText Creates a new ruby element with raw text content. Uses text.RawText which is not HTML-escaped. Example: ruby.RawText("漢<rt>かん</rt>") Renders: <ruby>漢<rt>かん</rt></ruby>

func RawTextf

func RawTextf(format string, args ...any) *element

RawTextf Creates a new ruby element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: ruby.RawTextf("%s<rt>%s</rt>", kanji, reading) Renders: <ruby>漢<rt>かん</rt></ruby>

func Static

func Static(content string) *element

Static Creates a new ruby element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: ruby.Static("日本") Renders: <ruby>日本</ruby>

func Text

func Text(content string) *element

Text Creates a new ruby element with text content. Uses text.Text which HTML-escapes the output. Example: ruby.Text("東京") Renders: <ruby>東京</ruby>

func Textf

func Textf(format string, args ...any) *element

Textf Creates a new ruby element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: ruby.Textf("%s", kanji) Renders: <ruby>漢</ruby>

Types

type Element

type Element = element

Element is an exported alias for the private element type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL