feat: add markdown support for user notes #6490
Conversation
* Initial plan * Add Markdown rendering support to Label widget Co-authored-by: jacob-thompson <49221320+jacob-thompson@users.noreply.github.com> * Fix markdown rendering and add preview toggle to notes editor Co-authored-by: jacob-thompson <49221320+jacob-thompson@users.noreply.github.com> * remove extraneous brace * formatting * formatting * remove some comments Co-authored-by: jacob-thompson <49221320+jacob-thompson@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jacob-thompson <49221320+jacob-thompson@users.noreply.github.com> Co-authored-by: Jacob Thompson <jacobalthompson@gmail.com>
|
Hello Jacob, thank you for your submission. It looks technically sound and I like the usage of QTextDocument to handle markdown. What I fear is that this feature will only be available to very technical users because it's necessary to know markdown to use it. I also fear that the markdown preview is confusing for users as it will likely show the same text as the left side if no markup is added. To open this feature up for everyone I think it's necessary to hide the fact that we are using markdown under the hood. A graphical way of formatting (a toolbar with buttons for bold, italics, lists, etc.) would be intuitive and inviting. After all, this is a sub-dialog so why not keep the user interface simple there. The document can be loaded and saved as markdown automatically, so it would "just work" for the user. What do you think about this? It's also possible to go ahead with your suggested GUI for now and reconsider it later. |
|
I don't think we need to hide that we're using markdown. I think we
should take some inspiration from Discord and don't do full WYSIWYG but
instead do buttons for inserting md syntax and syntax highlighting like:
- <b>**this text is bold**</b>
- <em>_this is in italics_</em>
- ...
W dniu 26.09.2025 o 13:23, fourtf pisze:
… *fourtf* left a comment (Chatterino/chatterino2#6490) <https://
github.com/Chatterino/chatterino2/pull/6490#issuecomment-3338215817>
Hello Jacob, thank you for your submission. It looks technically sound
and I like the usage of QTextDocument to handle markdown.
What I fear is that this feature will only be available to very
technical users because it's necessary to know markdown to use it. I
also fear that the markdown preview is confusing for users as it will
likely show the same text as the left side if no markup is added.
To open this feature up for everyone I think it's necessary to hide the
fact that we are using markdown under the hood. A graphical way of
formatting (a toolbar with buttons for bold, italics, lists, etc.) would
be intuitive and inviting. After all, this is a sub-dialog so why not
keep the user interface simple there. The document can be loaded and
saved as markdown automatically, so it would "just work" for the user.
What do you think about this? It's also possible to go ahead with your
suggested GUI for now and reconsider it later.
|
|
Yeah maybe it's fine. The user doesn't have to use the markdown preview if he doesn't understand or want it. |
fixes #6319
extends the
Labelwidget to render markdown for user notes, and adds a toggle for a live markdown preview to theEditUserNotesDialogScreen.Recording.2025-09-25.at.02.35.05.mov