ckeditor / github-writer

GitHub Writer - WYSIWYG Rich-Text Editor for GitHub, powered by CKEditor.
https://ckeditor.com/
Other
376 stars 61 forks source link

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

Open zm-cttae opened 1 year ago

zm-cttae commented 1 year ago

⚡️️ Feature Request

Problem statement

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 commented 1 year ago

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

zm-cttae commented 1 year ago

Reopening in case the upstream PR is rejected