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

[opinionated] Prefer emitting - over * for unordered list markup #438

Closed
zm-cttae opened this issue Jan 17, 2023 · 2 comments
Closed

[opinionated] Prefer emitting - over * for unordered list markup #438

zm-cttae opened this issue Jan 17, 2023 · 2 comments
Labels
enhancement A possible enhancement of an existing feature.

Comments

@zm-cttae
Copy link

zm-cttae commented Jan 17, 2023

⚡️️ Feature Request

Problem statement

  • As a: open-source developer writing issues on GitHub
  • I want to: use the same modern Markdown settings as my organisation or repository
  • So that: I can onboard and share comments consistent to a Markdown style guide.

Proposed solution

Adopt the GitHub and CommonMark conventions of Markdown formatting punctuation/operators.
In an ideal world the editor would emit - for unordered lists.
Other settings are { headingStyle: 'atx', bulletListMarker: '-', emDelimiter: '*', br: '\n' }
Technically, this is a breaking change to the project and may not be worth the dev time.

Describe alternatives you've considered

A setting is provided so that users can select their preference.
This is more complex and requires a big growth to the the codebase.
Honestly why would someone intentionally want to use * and setext headings like ## Header 2 ##.
It seems secondary to having some saner defaults.


If you'd like to see this improvement implemented, add a 👍 reaction to this post.

@zm-cttae zm-cttae added the enhancement A possible enhancement of an existing feature. label Jan 17, 2023
@zm-cttae
Copy link
Author

This has nothing to do with github writer - it's a upstream issue in turndown. mixmark-io/turndown#424

@zm-cttae zm-cttae closed this as not planned Won't fix, can't repro, duplicate, stale Jan 17, 2023
@zm-cttae
Copy link
Author

zm-cttae commented Mar 4, 2023

Reopening in case the upstream PR is rejected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement A possible enhancement of an existing feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant