search

ckeditor / github-writer

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

HTML comments handling #136

Open mlewand opened 4 years ago

mlewand commented 4 years ago

It's not rare to see repositories that place some information/hints as comments in the issue templates.

For instance I was just making issue/PR in https://github.com/sidoh/esp8266_milight_hub repository and there are critical explaination about placing the logs:


#### Firmware version
<!-- e.g. 1.10.0-rc.1, etc.  include all versions you've tried -->

#### Output of http://milight-hub.local/about

```json
"... /about output. put between the ```s"

Output of http://milight-hub.local/settings

"... /settings output. put between the ```s"


The final GH RTE needs to properly present this information. There could be simply an inline widget with the text placed inside 🤷‍♂️ The important thing though is to make it clear that this is a comment and will not be publicly visible after submitting the content. It should ofc also be removable (which will actually be cool, because it takes time in plain text editor to remove it).
CKEditorBot commented 1 year ago

There has been no activity in this issue for the last three years. Now it is marked as stale and will be closed in 30 days. We know it may be valid, so if you're interested in the solution, leave a comment or reaction.

CKEditorBot commented 11 months ago

We have closed the issue because of the lack of activity for the last three years. We know it might be valid, so you can open a similar issue if needed.