Documentation
¶
Overview ¶
Package ruby provides constructors and methods for the HTML <ruby> element.
The <ruby> HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of East Asian characters.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TagOpen = []byte("<ruby") TagClose = []byte("</ruby>") )
Byte constants for HTML rendering.
Functions ¶
func New ¶
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 ¶
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>
Source Files