Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rule: Blank lines in between list items #25

Open
mivok opened this issue Jul 7, 2014 · 2 comments
Open

Rule: Blank lines in between list items #25

mivok opened this issue Jul 7, 2014 · 2 comments
Labels

Comments

@mivok
Copy link
Collaborator

mivok commented Jul 7, 2014

From: http://www.cirosantilli.com/markdown-styleguide/#lists-and-empty-lines

(Edit: the link is now http://www.cirosantilli.com/markdown-style-guide/#empty-lines-inside-lists )

The style guide actually specifies that there should always be blank lines between all list items in a given list, or there should be no blank lines in between list items. We should check a document for inconsistent list separation. Note: This is just inconsistency within a single list (and not even in nested lists), not across the entire document.

See also #26 and #27 for list blank line rules, as well as a possibility for detecting list separation style.

My original thinking behind the rule was attempting to separate two lists by a single blank line, and them being rendered as a single list, which wouldn't be what the document author apparently intended. However, detecting the document style and reporting inconsistency works also. The documentation of the rule should explain that blank lines in between list items doesn't separate lists as well as referring to the style guide.

@mivok mivok added the new rule label Jul 7, 2014
@mivok
Copy link
Collaborator Author

mivok commented Jul 7, 2014

See also: http://www.cirosantilli.com/markdown-styleguide/#separate-consecutive-elements. This covers my original rationale, and I suspect the blockquote rule and other rules will cover other mistaken cases of element separation.

@mivok mivok added the on deck label Oct 26, 2014
@mivok mivok removed the on deck label Apr 11, 2015
@vinckr
Copy link

vinckr commented Feb 8, 2022

Is there a rule or tweaking/combination of rules I can use to achieve this currently?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants