Returns if the given AST node is a block element.

Returns the type of child expected for the given AST node.

This function returns either :block or :inline.

Returns if the given AST node is an inline element.

Produces the Pandoc AST data structure of the given Panpipe AST node.

Examples

iex> %Panpipe.AST.Header{level: 1, children: [%Panpipe.AST.Str{string: "Example"}]}
...> |> Panpipe.AST.Node.to_pandoc()
%{
  "c" => [1, ["", [], []], [%{"c" => "Example", "t" => "Str"}]],
  "t" => "Header"
}

Transforms the AST under the given Panpipe AST node by applying the given transformation function recursively.

The given function will be passed all nodes in pre-order and will replace those nodes for which the transformation function fun returns a non-nil replacement value. A node can also be replaced with a sequence of new nodes by returning a list of nodes in the transformation function. If you want to remove a node, you can return an empty list or a Panpipe.AST.Null node.

The transformation will be applied recursively also on children of the replaced values. You can prohibit that by returning the replacement in a halt tuple like this: {:halt, replacement}.

Examples

Panpipe.ast!(input: "file.md")
|> Panpipe.transform(fn
   %Panpipe.AST.Header{} = header ->
     %Panpipe.AST.Header{header | level: header.level + 1}
   _ -> nil
 end)

Panpipe.ast!(input: "file.md")
|> Panpipe.transform(fn
   %Panpipe.AST.Header{} = header ->
     {:halt, %Panpipe.AST.Header{header | level: header.level + 1}}
   _ -> nil
 end)