viewlayout

package
v0.17.0 Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExampleSpecs

func ExampleSpecs() []string

ExampleSpecs returns the shared reference examples.

func Markdown

func Markdown(v Vocabulary) string

Markdown renders the host-neutral layout reference.

func MissingReferenceNames

func MissingReferenceNames(v Vocabulary) []string

MissingReferenceNames returns live vocabulary names that lack descriptive metadata. Tests use it to keep the reference explanatory as well as mechanically complete.

func Reference

func Reference(v Vocabulary) string

Reference renders the terminal layout reference.

func ReferenceBody

func ReferenceBody(v Vocabulary) string

ReferenceBody renders the host-neutral body (grammar plus pipeline vocabulary) without the terminal Usage/Examples framing — the shared surface behind both Reference and the view-grammar base fact.

Types

type Vocabulary

type Vocabulary struct {
	Functions  []string
	Renders    []string
	Algorithms []string
	Decays     []string
	Macros     []string
	// LayoutMacros are macros used alone as a whole layout (they expand into
	// several sections), not at section start.
	LayoutMacros []string
}

Vocabulary lists names accepted by the live view executors.

Jump to

Keyboard shortcuts

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