List

import { List } from "jsr:@ende/markdown";

interface

interface List

A bullet or ordered list.

Example: Usage

import type { List } from "@ende/markdown/types";
import { assertEquals } from "@ende/assert";

const node: List = { type: "list", ordered: true, start: 3, spread: false, children: [] };
assertEquals(node.start, 3);

Properties

`type`

type: "list"

Node type.

`ordered`

ordered: boolean

Whether the list is ordered (1.) rather than bulleted (-).

`start`

start: number | null

The number of the first item of an ordered list, or null for a bullet list.

`spread`

spread: boolean

Whether the list is loose: blank lines separate its items, or the blocks inside any item. The items of a loose list render inside <p> tags.

`children`

children: ListItem[]

The list items.

Source