mdsmith
Esc
    v0.52.0 GitHub
    MDS061 list ready

    MDS061: list-marker-space

    Each list marker must be followed by the configured number of spaces.

    # Settings

    SettingTypeDefaultDescription
    ul-singleint1Spaces after unordered marker, single items
    ul-multiint1Spaces after unordered marker, multi items
    ol-singleint1Spaces after ordered marker, single items
    ol-multiint1Spaces after ordered marker, multi items

    A list item is “multi” when it has more than one block-level child (a blank-line-separated continuation paragraph, a nested list, or a code block inside the item). Single items have one block child.

    ul-multi and ol-multi are checked but not auto-fixed. Adjusting the marker gap on a multi-paragraph item requires re-indenting every continuation line by the same delta; doing so correctly across all block child types is left to the author. Single-paragraph items are fixed automatically.

    # Config

    Enable with default settings (one space everywhere):

    rules:
      list-marker-space: true

    Disable:

    rules:
      list-marker-space: false

    Require two spaces after the marker for multi-paragraph items:

    rules:
      list-marker-space:
        ul-multi: 2
        ol-multi: 2

    # Examples

    # Good – one space

    # Unordered list marker space
    
    One space after each unordered marker.
    
    - First item
    - Second item
    - Third item

    # Good – ordered list

    # Ordered list marker space
    
    One space after each ordered marker.
    
    1. First item
    2. Second item
    3. Third item

    # Bad – two spaces

    # Two spaces after unordered marker
    
    Unordered list with two spaces after each marker.
    
    -  First item
    -  Second item

    # Bad – ordered two spaces

    # Two spaces after ordered marker
    
    Ordered list with two spaces after each marker.
    
    1.  First item
    2.  Second item

    # Meta-Information

    • ID: MDS061
    • Name: list-marker-space
    • Status: ready
    • Default: enabled
    • Fixable: single-paragraph items only
    • Implementation: source
    • Category: list
    • markdownlint: MD030 (list-marker-space)
    • rumdl: MD030 (list-marker-space)
    • mado: MD030 (list-marker-space)
    • obsidian-linter: space-after-list-markers