list

Documentation

Overview

Package list exports list-related schema elements and commands. The commands assume lists to be nestable, with the restriction that the first child of a list item is a plain paragraph.

Index

• func AddListNodes(nodes []*model.NodeSpec, itemContent, listGroup string) []*model.NodeSpec

Functions

func AddListNodes

func AddListNodes(nodes []*model.NodeSpec, itemContent, listGroup string) []*model.NodeSpec

AddListNodes is a onvenience function for adding list-related node types to a map specifying the nodes for a schema. Adds orderedList as "ordered_list", bulletList as "bullet_list", and listItem as "list_item".

itemContent determines the content expression for the list items. If you want the commands defined in this module to apply to your list structure, it should have a shape like "paragraph block*" or "paragraph (ordered_list | bullet_list)*". listGroup can be given to assign a group name to the list node types, for example "block".