twig - v0.1.1

twig

Types

Attr

opaque </>

A typed attribute for a specific element type.

The phantom type element ensures attributes can only be used with their intended element. For example, Attr(HeadingAttr) cannot be passed to bullet_list which expects Attr(ListAttr).

pub opaque type Attr(element)

Content

</>

The core content type representing any Typst element.

  • Text holds a raw string value
  • Node represents a Typst function call like #heading[...]
  • Sequence groups multiple content elements together
pub type Content {
  Text(String)
  Node(name: String, attrs: List(String), children: NodeChildren)
  Sequence(List(Content))
}

Constructors 

  • Text(String)
  • Node(name: String, attrs: List(String), children: NodeChildren)
  • Sequence(List(Content))

NodeChildren

</>

Controls how a node’s children are rendered.

  • SingleChild renders all children in one block [child1child2]
  • MultiChild renders each child in its own block [child1][child2]
  • InlineChildren renders all children in one block child1, child2
pub type NodeChildren {
  SingleChild(List(Content))
  MultiChild(List(Content))
  InlineChildren(List(Content))
}

Constructors

Values

inline_node

</> 
pub fn inline_node(
  name: String,
  attrs: List(Attr(a)),
  children: List(Content),
) -> Content

make_attr

</> 
pub fn make_attr(key: String, value: String) -> Attr(a)

Constructs a named attribute key-value pair.

This is intended for use by twig submodules only, not end users. End users should use the typed attribute constructors like level(1) or marker(TextMarker("--")) instead.

make_positional

</> 
pub fn make_positional(value: String) -> Attr(a)

Constructs a positional attribute value.

This is intended for use by twig submodules only, not end users. Used for Typst functions that take positional arguments like #v(5em).

multi_node

</> 
pub fn multi_node(
  name: String,
  attrs: List(Attr(a)),
  children: List(Content),
) -> Content

Constructs a Node where each child gets its own content block [...].

Use this for elements like bullet_list where each child is a separate item.

Example

multi_node("list", [], [text("item1"), text("item2")])
// -> "#list[item1][item2]"

node

</> 
pub fn node(
  name: String,
  attrs: List(Attr(a)),
  children: List(Content),
) -> Content

Constructs a Node where all children are rendered into a single block [...].

This is the core building block used by most element constructors in twig submodules. Use multi_node for elements like bullet_list where each child needs its own block.

Example

node("heading", [level(1)], [text("Hello")])
// -> "#heading(level: 1)[Hello]"

render

</> 
pub fn render(content: Content) -> String

Renders a Content tree into a Typst source string.

This is the final step, call this on your document root and write the result to a .typ file.

Example

model.heading([model.level(1)], [text.text("Hello")])
|> render()
// -> "#heading(level: 1)[Hello]"
✨ Search Document