frame

package module
v0.1.3 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2025 License: Unlicense Imports: 20 Imported by: 0

README

frame

Universal frames for reference.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Element

type Element interface {
	Markdown() *goldmark.Markdown
	H1(s string) *One
	H2(s string) *One
	H3(s string) *One
	H4(s string) *One
	H5(s string) *One
	H6(s string) *One
	Paragraph(s string) *One
	Span(s string) *One
	Strong(s string) *One
	Em(s string) *One
	Small(s string) *One
	Mark(s string) *One
	Del(s string) *One
	Ins(s string) *One
	Sub(s string) *One
	Sup(s string) *One
	Kbd(s string) *One
	Samp(s string) *One
	VarElem(s string) *One
	Abbr(s string) *One
	Time(s string) *One
	Button(label string) *One
	Code(code string) *One
	CodeBlock(lang, code string) *One

	Div(class string) *One
	WrapDiv(class string, children ...*One) *One
	Link(href, text string) *One
	List(items []any, ordered bool) *One
	Img(src, alt, reference string) *One
	Video(src string) *One
	Audio(src string) *One
	Iframe(src string) *One
	Embed(src string) *One
	Source(src string) *One
	Canvas(id string) *One
	Table(cols uint8, rows uint64, data [][]string) *One
}

func NewElement

func NewElement() Element

type Forge

type Forge interface {
	Build(class string, updateIndex bool, elements ...*One) *One
	JS(js string) One
	CSS(css string) One
	UpdateIndex(*One)
	Count() int
	Keyboard()
	ApiURL() string
	GetFrame(idx int) *One
	AddPath(dir string) string
	AddFile(filePath string, prefix string) error
	Element
	Zero(heading, github, x string)
	TextStyle() *One
	README(file string, cssPath string) *One
	BuildSlides(dir string) *One
	ScrollKeybinds() *One
}

func NewForge

func NewForge(mux *mux.Router, apiUrl string) Forge

type Frame

type Frame interface {
	Serve()
	Forge
	// contains filtered or unexported methods
}

func NewFrame

func NewFrame(pathlessUrl, apiURL string) Frame

type One

type One template.HTML

func Tag

func Tag(tag, text string) *One

Jump to

Keyboard shortcuts

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