ckeditor / github-writer

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

Extension is escaping square brackets use to create task lists in Issues #237

Open trackwell-mike opened 3 years ago

trackwell-mike commented 3 years ago

I have noticed that your extension seems to be escaping square brackets when they are being used for Task Lists in Issues.

While this will still render the Task List checkboxes, the backslash makes the boxes read-only so you can't check them.

See here: https://share.getcloudapp.com/Wnullrov

fredck commented 3 years ago

That's because you're creating the lists by typing the brackets, so GitHub Writer see them as plain text actually. Unfortunately there is no auto-formatting for task lists and the only right way to create them is by using the toolbar button.

The really weird thing here is that GitHub still creates the task list, despite the brackets being escaped. Escaping in fact is a way to say "hey, this is not Markdown markup" so it should be rendered as plain text. For instance, how would you have a normal bullet list with text starting with [ ]? Maybe there are other ways for it, but slash-escaping is the most obvious one.

So, what we're probably really dealing with here is a GitHub bug :disappointed: