[GH-ISSUE #45] MD029 is triggered on any multiline ordered list items. #1884

Closed
opened 2026-03-07 20:02:24 +03:00 by kerem · 9 comments
Owner

Originally created by @rroman81 on GitHub (Feb 6, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/45

I am using the markdownlint v0.6.2 and I am seeing that the MD029 rule is always triggered even when using the sample provided inside the rule.
i.e.

1. Do this.
2. Do that.
3. Done.

should pass the issue but it is generating green swiggle with MD029 tooltip.

Originally created by @rroman81 on GitHub (Feb 6, 2017). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/45 I am using the markdownlint v0.6.2 and I am seeing that the MD029 rule is always triggered even when using the sample provided inside the rule. i.e. ```markdown 1. Do this. 2. Do that. 3. Done. ``` should pass the issue but it is generating green swiggle with MD029 tooltip.
kerem 2026-03-07 20:02:24 +03:00
  • closed this issue
  • added the
    question
    label
Author
Owner

@DavidAnson commented on GitHub (Feb 7, 2017):

Documentation: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029---ordered-list-item-prefix

MD029 has two modes: one and ordered. The default mode is one which looks for the following style:

1. First
1. Second
1. Third

The benefit of this style is that lines can be reordered without having to worry about the numbers going out of sequence. If you wish to change the style to ordered per your example above, you can update the rule configuration via one of the supported mechanisms:

<!-- gh-comment-id:277859620 --> @DavidAnson commented on GitHub (Feb 7, 2017): Documentation: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029---ordered-list-item-prefix MD029 has two modes: `one` and `ordered`. The default mode is `one` which looks for the following style: ``` 1. First 1. Second 1. Third ``` The benefit of this style is that lines can be reordered without having to worry about the numbers going out of sequence. If you wish to change the style to `ordered` per your example above, you can update the rule configuration via one of the supported mechanisms: - https://github.com/DavidAnson/markdownlint#configuration - https://github.com/DavidAnson/vscode-markdownlint#configure
Author
Owner

@s10wen commented on GitHub (Sep 26, 2017):

Landed here as this caught me out as well, updating to ordered it is then, thanks.

<!-- gh-comment-id:332143241 --> @s10wen commented on GitHub (Sep 26, 2017): Landed here as this caught me out as well, updating to `ordered` it is then, thanks.
Author
Owner

@s10wen commented on GitHub (Sep 26, 2017):

I'm new to VS, I've gone to settings and added the markdown code, but having trouble with the syntax, tried a few things but no luck, does anyone have an example for the settings code I should be using here please?

e.g.

{
    "workbench.colorTheme": "Monokai",
    "workbench.iconTheme": "vscode-icons",
    "editor.renderWhitespace": "all",
    "[markdown]": {
      "editor.wordWrap": "on",
      "editor.quickSuggestions": false,
      "editor.ol-prefix": "ordered"
    }
  }
<!-- gh-comment-id:332146252 --> @s10wen commented on GitHub (Sep 26, 2017): I'm new to VS, I've gone to settings and added the markdown code, but having trouble with the syntax, tried a few things but no luck, does anyone have an example for the settings code I should be using here please? e.g. ``` { "workbench.colorTheme": "Monokai", "workbench.iconTheme": "vscode-icons", "editor.renderWhitespace": "all", "[markdown]": { "editor.wordWrap": "on", "editor.quickSuggestions": false, "editor.ol-prefix": "ordered" } } ```
Author
Owner

@DavidAnson commented on GitHub (Sep 26, 2017):

On a phone right now, but if you edit VS Code config files from within the app, it will provide auto-complete suggestions to help. You should end up with something like what you see towards the bottom of this section:
https://github.com/DavidAnson/vscode-markdownlint/blob/master/README.md#configure

<!-- gh-comment-id:332250496 --> @DavidAnson commented on GitHub (Sep 26, 2017): On a phone right now, but if you edit VS Code config files from within the app, it will provide auto-complete suggestions to help. You should end up with something like what you see towards the bottom of this section: https://github.com/DavidAnson/vscode-markdownlint/blob/master/README.md#configure
Author
Owner

@s10wen commented on GitHub (Sep 27, 2017):

Thanks, managed to sort this, in case anyone else comes here, I'd clicked the top one here, instead of the bottom example code:

screen shot 2017-09-27 at 08 11 01

I now have:

{
    "workbench.colorTheme": "Monokai",
    "workbench.iconTheme": "vscode-icons",
    "editor.renderWhitespace": "all",
    "markdownlint.config": {
      "MD029": false,
      "MD034": false
    }
  }
<!-- gh-comment-id:332430902 --> @s10wen commented on GitHub (Sep 27, 2017): Thanks, managed to sort this, in case anyone else comes here, I'd clicked the top one here, instead of the bottom example code: <img width="500" alt="screen shot 2017-09-27 at 08 11 01" src="https://user-images.githubusercontent.com/1136114/30900308-78376206-a35b-11e7-814d-72875274c870.png"> I now have: ``` { "workbench.colorTheme": "Monokai", "workbench.iconTheme": "vscode-icons", "editor.renderWhitespace": "all", "markdownlint.config": { "MD029": false, "MD034": false } } ```
Author
Owner

@amoghskulkarni commented on GitHub (Oct 16, 2017):

I created .markdownlint.json in my root folder and added following snippet in that -

{
    "default": true,
    "ol-prefix": { "style": "ordered" }
}

But the linting still occurs at 2. showing green squiggly line, saying MD029/ol-prefix: Ordered list item prefix [Expected: 1; Actual: 2].

Am I missing something?

<!-- gh-comment-id:336784134 --> @amoghskulkarni commented on GitHub (Oct 16, 2017): I created `.markdownlint.json` in my root folder and added following snippet in that - ```json { "default": true, "ol-prefix": { "style": "ordered" } } ``` But the linting still occurs at `2.` showing green squiggly line, saying `MD029/ol-prefix: Ordered list item prefix [Expected: 1; Actual: 2]`. Am I missing something?
Author
Owner

@DavidAnson commented on GitHub (Oct 16, 2017):

Can you show the Markdown you are getting the wrong result for?

<!-- gh-comment-id:336785202 --> @DavidAnson commented on GitHub (Oct 16, 2017): Can you show the Markdown you are getting the wrong result for?
Author
Owner

@DavidAnson commented on GitHub (Oct 16, 2017):

And say what tool or code you are using to lint.

<!-- gh-comment-id:336786186 --> @DavidAnson commented on GitHub (Oct 16, 2017): And say what tool or code you are using to lint.
Author
Owner

@0xCourtney commented on GitHub (May 18, 2020):

In case you're confused about how to use ordered lists with this rule in place...

It’s important to note that the actual numbers you use to mark the list have no effect on the HTML output Markdown produces.

Original Markdown Spec

<!-- gh-comment-id:630198046 --> @0xCourtney commented on GitHub (May 18, 2020): In case you're confused about how to use ordered lists with this rule in place... > It’s important to note that the actual numbers you use to mark the list have no effect on the HTML output Markdown produces. Original Markdown Spec
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/markdownlint#1884
No description provided.