hedgedoc / react-client

The frontend of the upcoming version 2.0
https://hedgedoc.dev
GNU Affero General Public License v3.0
104 stars 13 forks source link

Keyboard & Mouse Shortcut Representation in Markdown extension #1959

Closed ethereal-engineer closed 2 years ago

ethereal-engineer commented 2 years ago

Is your feature request related to a problem? Please describe.

Recently I have been using HedgeDoc 1.x to write cheatsheets for the 3D modelling package Blender. In order to have the most presentable, clean aesthetic, I have been using this notation:

Shortcut Name Example Description
g grab g x 10 grab and move forward along the x axis 10 units
r rotate r y 90 rotate 90 degrees around the y axis

... which looks great when the mouse isn't involved. This is the nicest I could get it looking, whilst still conveying information quickly, in a minimal way:

Key Function Notes
ctrlshiftx activate anywhere in the 3D viewport
space cycle through cutting shapes (once activated - duh)
ctrlLMB reposition cursor
d toggle cursor depth use with repositioning the cursor (above)

Describe the solution you'd like

What I'd like to see is a way of representing the mouse for documentation such as this. Initially, just a 3-button mouse with the appropriate button emphasised, but it could extend to scroll wheel depiction, dragging, double click action, and more. It would also be nice to have an extension to the ML interpreter so that HTML tags were unnecessary.

Describe alternatives you've considered

What I thought would be a cool, more general feature, would be the ability to reference FontAwesome glyphs, and/or Google Material Design glyphs (and hey maybe even Google Fonts) from within a document. Perhaps by defining imports in the YAML section?

Additional context

mrdrogdrog commented 2 years ago

Hello,

We use https://forkaweso.me/Fork-Awesome/ as our icon lib. You could go to their repo and open icon requests. As soon as they would be included in a release we can use them.

ErikMichelson commented 2 years ago

I'm going to close this issue. As mentioned by @mrdrogdrog you could create the needed icon requests over at ForkAwesome, as we include that as our icon library. We cannot do anything here from our point.