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

Add "Write" and "Preview" tabs over comments, for easier editing of Markdown #2791

Open
poperigby opened this issue May 27, 2020 · 3 comments
Labels
Component: Comments Type: Feature Request ✨ UI non-trivial UI changes, that might need discussion

Comments

@poperigby
Copy link

It would be similar to how GitHub does it, and it would make it easier to see how your comment's markdown would render.

@Chocobozzz Chocobozzz added Type: Feature Request ✨ UI non-trivial UI changes, that might need discussion labels May 27, 2020
@thomask-gh
Copy link
Contributor

Or maybe use a simple and small WYSIWYG markdown editor? (like pell?)

@poperigby
Copy link
Author

poperigby commented May 27, 2020

I think Markdown is more accessible and easier to work with than WYSIWYG because it's so simple. Riot gave a good explanation of it in this article: https://blog.riot.im/riot-web-1-5/

@thomask-gh
Copy link
Contributor

thomask-gh commented May 28, 2020

Well, why not, might indeed be simpler. I'm OK with Riot's solution (the one mentioned in your article) because of this: (emphasis is mine)

The most noticable change is that we’ve dropped WYSIWYG formatting in favour of markdown. Users who might not be familiar with markdown formatting will be nudged in the right direction through contextual formatting options that appear when you select text:

Riot's message composer

Indeed, the vast majority of normal people who just watch videos on the internet never ever heard of Markdown, so having buttons to style their comments will help them, even if these buttons just insert the necessary ** or __ or whatever else, just like they do here in GitHub. And in this case it would indeed be useful to have a "preview" option like you suggest.

So what I'm suggesting here might in fact be another feature, complementary to the one you suggest: have buttons to help people who don't know Markdown yet style their comments with it. And just like on GitHub, there might be a small icon or mark that indicates that "Styling with Makrdown is supported" with a link to a small guide on Markdown syntax. 🙂

(PS: I'm not technical enough to know, but maybe it would be easier to just use a small library like pell or another one than it would be to implement all this buttons + preview tab + help link stuff, I don't know)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Comments Type: Feature Request ✨ UI non-trivial UI changes, that might need discussion
Projects
None yet
Development

No branches or pull requests

3 participants