CondeNast/atjson

Remove the concept of "tight" lists

Closed this issue · 1 comments

Commonmark has a concept of "tight" lists, which is a shorthand that says whether there should be surrounding whitespace in a list item or not. We've adopted this into the offset-annotations package, which I believe is a mistake. It has the potential of causing changes in behavior because a client is unaware of how they should render the markup with / without the tight parameter.

In addition to this, it changes how annotations should be rendered according to the outer context.

The proposal is to wrap list items to wrap list items in paragraphs if tight is false in the converter from markdown to atjson.

We've made a decision here to convert paragraphs into 2 line breaks inside of list items.

Our primary motivating factor here is that it's super difficult to have a keyboard shortcut to insert a paragraph inside of a list item. (shift+enter usually is LineBreak in most text editors and inside of a list item, enter is a new ListItem).