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

[WIP] mini markdown cheatsheet by comment form #1809

Closed
wants to merge 10 commits into from

Conversation

mariocsee
Copy link
Contributor

@mariocsee mariocsee commented Feb 15, 2019

What type of PR is this? (check all applicable)

  • Feature

Description

Adds a hidden section near the comment input for same window markdown cheatsheet. Clicking the info button opens and closes the section.

Still deciding whether to put the editor guide (/p/editor_guide) or markdown guide (https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet) in a scroll view or have a more condensed markdown cheatsheet designed with a link to the editor guide or markdown cheatsheet if the user needs a more detailed guide.

Update:
When textarea is in focus, the markdown hints appear—just like Slack.
When you click on the Markdown button to the right of image upload, the section below with more markdown details shows. (more shortcuts can be added)
Not sure whether to use one or both.
The cheatsheet pushes the comment section down a little, but can also be made to appear on top of the first comment.

Related Tickets & Documents

Resolves #49

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

Screen Shot 2019-03-12 at 15 47 08

Added to documentation?

  • no documentation needed

@mariocsee mariocsee changed the title [WIP] add mini markdown cheatsheet near comments [WIP] mini markdown cheatsheet by comment form Mar 12, 2019
@mariocsee mariocsee changed the title [WIP] mini markdown cheatsheet by comment form mini markdown cheatsheet by comment form Mar 15, 2019
@mariocsee mariocsee changed the title mini markdown cheatsheet by comment form [WIP] mini markdown cheatsheet by comment form Mar 15, 2019
@omenking
Copy link
Contributor

omenking commented Apr 8, 2019

I think what I would want here is liquid tags since I always have to hunt those down.
For me, this is more useful in writing a post than writing in comments.

@mariocsee
Copy link
Contributor Author

Will revisit in the future.

@mariocsee mariocsee closed this Jul 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convenient Markdown Cheat Sheet in Comments editor
2 participants