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

Sublist behavior change: Sublists with single space are not rendered as sublists #1923

Closed
bwittenberg opened this issue Feb 1, 2021 · 6 comments · Fixed by #1924
Closed
Labels
category: lists L2 - annoying Similar to L1 - broken but there is a known workaround available for the issue parser: Pedantic released works as intended

Comments

@bwittenberg
Copy link

Marked version:
v1.2.3

Describe the bug
Sublists single indent are not rendered as html sublists.

Why is this significant? To borrow from the github flavored markdown spec: (https://github.github.com/gfm/#why-is-a-spec-needed-)

How much indentation is needed for a sublist? The spec says that continuation paragraphs need to be indented four spaces, but is not fully explicit about sublists. It is natural to think that they, too, must be indented four spaces, but Markdown.pl does not require that. This is hardly a “corner case,” and divergences between implementations on this issue often lead to surprises for users in real documents.

I upgraded from v0.8.2 to v1.2.5, and some customers relied on sublist indentation of a single space.

It looks like the behavior change shipped in v1.2.3.

Here is a comparison of changes between versions:
v1.2.2...v1.2.3

To Reproduce
Steps to reproduce the behavior:

v1.2.3 Demo

v1.2.2 Demo

Expected behavior
I don't know the optimal way to handle this behavior change, and I would appreciate feedback/suggestions.

Maybe setting pedantic=true should render sublists similar to v1.2.2 for the following input?

- one
 - two

To see how markdown.pl handles the input, visit:
https://daringfireball.net/projects/markdown/dingus

@UziTech
Copy link
Member

UziTech commented Feb 1, 2021

This was fixed in v1.2.3

We are following GFM and CommonMark

CommonMark demo

GFM demo:

- one
 - two
  • one
  • two

@UziTech
Copy link
Member

UziTech commented Feb 1, 2021

I suppose we should keep behavior for pedantic

@UziTech UziTech added L2 - annoying Similar to L1 - broken but there is a known workaround available for the issue parser: Pedantic labels Feb 1, 2021
@bwittenberg
Copy link
Author

@UziTech : Thanks for the quick feedback.

I suppose we should keep behavior for pedantic

Is this something you plan on implementing?

@bwittenberg
Copy link
Author

@UziTech : Whoops, I didn't see the PR above. Looks like you are already working on it. Thank you!

@UziTech
Copy link
Member

UziTech commented Feb 2, 2021

This is fixed in #1924

@github-actions
Copy link

github-actions bot commented Feb 3, 2021

🎉 This issue has been resolved in version 1.2.9 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: lists L2 - annoying Similar to L1 - broken but there is a known workaround available for the issue parser: Pedantic released works as intended
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants