starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 01:05:55 +03:00

[GH-ISSUE #11] Rule MD004 incorrectly flagging on an Ordered List #7

New issue

Closed

opened 2026-03-03 01:22:58 +03:00 by kerem · 5 comments

kerem commented

2026-03-03 01:22:58 +03:00

Owner

Originally created by @gryte on GitHub (Feb 9, 2016).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/11

I'm getting flagged on the following. Am I missing something obvious?

1. Fork the repository on Github
+ Create a named feature branch (like `add_component_x`)
+ Write your change
+ Write tests for your change (if applicable)
+ Run the tests, ensuring they all pass
+ Submit a Pull Request using Github

Originally created by @gryte on GitHub (Feb 9, 2016). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/11 I'm getting flagged on the following. Am I missing something obvious? ``` 1. Fork the repository on Github + Create a named feature branch (like `add_component_x`) + Write your change + Write tests for your change (if applicable) + Run the tests, ensuring they all pass + Submit a Pull Request using Github ```

kerem closed this issue

2026-03-03 01:22:59 +03:00

kerem commented

2026-03-03 01:22:59 +03:00

Author

Owner

@DavidAnson commented on GitHub (Feb 10, 2016):

Are you on the latest version of markdownlint?

I pasted your example into the top-left box of http://dlaa.me/markdownlint/ and do not see any MD004 violations.

Could you please try that?

@DavidAnson commented on GitHub (Feb 10, 2016): Are you on the latest version of markdownlint? I pasted your example into the top-left box of http://dlaa.me/markdownlint/ and do not see any MD004 violations. Could you please try that?

kerem commented

2026-03-03 01:22:59 +03:00

Author

Owner

@gryte commented on GitHub (Feb 11, 2016):

Interesting...yeah, I see what you mean if I use the website you referenced (nice by they way).

I confirmed that I'm on markdownlint version 0.3.0 which seems to be the latest in the marketplace.

I feel like I'm not using the correct md syntax to make an ordered list, but when I try the following, I get MD029 in both code and the website.

1. Fork the repository on Github
2. Create a named feature branch (like `add_component_x`)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

Do you have a good reference for appropriate syntax handy?

Thanks for the help!

@gryte commented on GitHub (Feb 11, 2016): Interesting...yeah, I see what you mean if I use the website you referenced (nice by they way). I confirmed that I'm on markdownlint version 0.3.0 which seems to be the latest in the marketplace. I feel like I'm not using the correct md syntax to make an ordered list, but when I try the following, I get MD029 in both code and the website. ``` 1. Fork the repository on Github 2. Create a named feature branch (like `add_component_x`) 3. Write your change 4. Write tests for your change (if applicable) 5. Run the tests, ensuring they all pass 6. Submit a Pull Request using Github ``` Do you have a good reference for appropriate syntax handy? Thanks for the help!

kerem commented

2026-03-03 01:23:00 +03:00

Author

Owner

@DavidAnson commented on GitHub (Feb 11, 2016):

You saying that version 0.3.0 is the latest in the marketplace makes me think you're referring to the markdownlint VS Code extension https://github.com/DavidAnson/vscode-markdownlint (which uses this markdownlint engine). However, I've tried your original example with that and still do not see the error you're reporting.

The reason your second example triggers MD029 is because the default configuration for MD029 is to prefer the style 1./1./1. over 1./2./3. because the latter is easier to get wrong. This is discussed in the relevant documentation page: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029---ordered-list-item-prefix You can change the default in the usual manner - here's an example: https://github.com/DavidAnson/markdownlint/blob/master/test/ordered_list_item_prefix_ordered.json For details on making that change for vscode-markdownlint, please see: https://github.com/DavidAnson/vscode-markdownlint#configure

Regarding documentation about syntax, I like the following:

@DavidAnson commented on GitHub (Feb 11, 2016): You saying that version 0.3.0 is the latest in the marketplace makes me think you're referring to the markdownlint VS Code extension https://github.com/DavidAnson/vscode-markdownlint (which uses this markdownlint engine). However, I've tried your original example with that and still do not see the error you're reporting. The reason your second example triggers MD029 is because the default configuration for MD029 is to prefer the style 1./1./1. over 1./2./3. because the latter is easier to get wrong. This is discussed in the relevant documentation page: https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md029---ordered-list-item-prefix You can change the default in the usual manner - here's an example: https://github.com/DavidAnson/markdownlint/blob/master/test/ordered_list_item_prefix_ordered.json For details on making that change for vscode-markdownlint, please see: https://github.com/DavidAnson/vscode-markdownlint#configure Regarding documentation about syntax, I like the following: - http://daringfireball.net/projects/markdown/ - http://commonmark.org/

kerem commented

2026-03-03 01:23:00 +03:00

Author

Owner

@gryte commented on GitHub (Feb 11, 2016):

Sorry I failed to mention I was in vs code. Thanks for the clarification!

@gryte commented on GitHub (Feb 11, 2016): Sorry I failed to mention I was in vs code. Thanks for the clarification!

kerem commented

2026-03-03 01:23:00 +03:00

Author

Owner

@DavidAnson commented on GitHub (Feb 19, 2016):

Closing this issue because it seems to have been resolved. If you're still having difficulty, let me know!

PS - I recently updated the VS Code markdownlint extension to v0.4.1, so please consider upgrading. :)

@DavidAnson commented on GitHub (Feb 19, 2016): Closing this issue because it seems to have been resolved. If you're still having difficulty, let me know! PS - I recently updated the VS Code markdownlint extension to v0.4.1, so please consider upgrading. :)

kerem referenced this issue

2026-03-03 01:30:13 +03:00

[PR #8] [CLOSED] Command line interface #800

kerem referenced this issue

2026-03-07 20:02:08 +03:00

[GH-ISSUE #7] A command line interface #1852

kerem referenced this issue

2026-03-07 20:09:54 +03:00

[PR #8] [CLOSED] Command line interface #2649