no-missing-blank-lines should allow for tight lists

[localjo]

I'm trying to add a table of contents which has multiple levels to a readme file. It should look like this;

- [Installation](#installation)
- [Usage](#usage)
  - [Options](#options)
  - [Reports](#reports)
  - [Custom Dictionary](#custom-dictionary)
  - [Changing Default Rules](#changing-default-rules)
- [Writing Standards](#writing-standards)
- [Troubleshooting](#troubleshooting)
- [Contribute](#contribute)
- [License](#license)

But when I run in through remark-lint, it says "Missing blank line before block node no-missing-blank-lines". To fix the warning, I have to turn off the rule (not ideal, because I do want to check for proper spacing between nodes) or format the block like this;

- [Installation](#installation)
- [Usage](#usage)

  - [Options](#options)
  - [Reports](#reports)
  - [Custom Dictionary](#custom-dictionary)
  - [Changing Default Rules](#changing-default-rules)
- [Writing Standards](#writing-standards)
- [Troubleshooting](#troubleshooting)
- [Contribute](#contribute)
- [License](#license)

Which renders incorrectly on GitHub and npm;

• Installation
• Usage
  • Options
  • Reports
  • Custom Dictionary
  • Changing Default Rules
• Writing Standards
• Troubleshooting
• Contribute
• License

This issue is similar to #79

[localjo]

For now I'm turning off this rule in quality-docs, https://github.com/SparkartGroupInc/quality-docs/blob/master/sample-rules-override.json#L11

Hopefully I can find a way to re-enable it soon.

[wooorm]

It’s not a bug, it’s exactly what this rule is for. In that list item, there’s a paragraph and a list (which are block-levels), so no-missing-blank-lines thinks there should be a blank between them.

Hopefully I can find a way to re-enable it soon.

Use comments? Or PR support for passing in exceptions (I’d appreciate it!)

[bkeepers]

I just ran into this as well. Most markdown implementations have different behavior for list items depending on the white space around them. If there is a blank line between list items, then they will wrap the list item in a paragraph (as @josiahsprague's example shows above). If there is not blank line between list items, then there will be no paragraph tag.

I understand that this complicates the implementation, but I feel like ignoring this rule for nested lists would be consistent with real-world use of markdown.

[wooorm]

@bkeepers Appreciate the input. Re-opening so we can track it.

From what I gather, this issue relates to an exception for a paragraph followed by a list, in a list item?

So:

- Paragraph
  - Nested

Yields:

• Paragraph
  • Nested

...and is allowed.

[bkeepers]

From what I gather, this issue relates to an exception for a paragraph followed by a list, in a list item?

Yep. Thanks for taking this into consideration. I looked into implementing it, but I'm still getting familiar with the remark code and it wasn't quite obvious to me the best way to solve it.

[wooorm]

Thanks both for convincing me this was needed. 👍 I’ll release it in a minute.

@bkeepers Appreciate you looking in. I think it’s a pretty hard project to get into, lots of moving parts. I’d like to make it easier to get into but I’m not really sure how to. If you’ve got any pointers I’d love to hear them (as issues, or Gitter, or whatnot).

Cheers!