Writerside
 
Get Writerside

Lists

Last modified: 05 June 2024

Organize items into ordered and unordered lists when documenting supported features or numbered annotations in a screenshot. Lists help emphasize important ideas and add visual structure similar to tables, admonitions, and tabs.

To add a list, use the <list> element and <li> sub-elements for each list item. By default, Writerside renders an unordered list with bullet points. Use the type attribute to change the list markers:

  • type="decimal": decimal digits (1, 2, 3, and so on) when the order or total number of items in a list is important

  • type="alpha-lower": letters (a, b, c, and so on) for an ordered nested list

  • type="none": for a list without markers

In Markdown, to create an ordered list, use numbers followed by periods. To create an unordered list, use dashes -, asterisks *, or plus characters +. Indent items to create a nested list. You can add list attributes in curly braces after an empty line.

<list type="decimal" start="2">
    <li>First item.
        <list type="alpha-lower">
            <li>First indented item.</li>
            <li>Second indented item.</li>
        </list>
    </li>
    <li>Second item.</li>
    <li>Third item.</li>
    <li>Fourth item.</li>
</list>

<list type="bullet">
    <li>Some list item</li>
    <li>Another list item</li>
    <li>Yet another list item
        <list type="bullet">
            <li>Indented item</li>
            <li>Indented item</li>
        </list>
    </li>
    <li>One more item</li>
</list>

Here is the list produced from the previous example:

  1. First item.

    1. First indented item.

    2. Second indented item.

  2. Second item.

  3. Third item.

  4. Fourth item.

  • Some list item

  • Another list item

  • Yet another list item

    • Some indented item

    • Another indented item

  • One more item