Comments (3)
This feature affects me too. I hope it will be added soon!
Thank you in advance.
from markdown-it-kbd.
Hi, thank you for your request! Before I created this plugin, I made sure to search the web for any existing syntax, to avoid exactly the situation of ‘competing standards’ that we have right now. Seem like that did not work out.
I would be willing to add an option to this plugin that allows modifying the delimiters. I think the required changes would me rather small. However, that would not improve your situation much, would it? Since you are consuming this plugin through a VSCode extension, you won’t be able to set the setting, even if I added it, will you?
Generally speaking, I think the best course of action would be to try to standardize the syntax somewhere. I would consider making a breaking change to adapt to an established standard. If you do, please don’t use the ++
syntax. For starters, I don’t think it fulfills mardown’s goal of being easy to understand. [[x]]
looks at least somewhat like a key with an x
in it. Furthermore, something like ++Ctrl+T++
(or even ++Ctrl++ + ++T++
) is just hard to parse for a human.
from markdown-it-kbd.
Thank you @jGleitz. Seeing that it's hard to end up in a common convention, we ended up using this syntax:
**`Ctrl`**+**`Alt`**+**`Del`**
Benefits:
- It renders nicely anywhere, even here on Github:
Ctrl
+Alt
+Del
- With a custom css for
strong > code
we are able to add a shadow etc to make it look even more like a key
Drawbacks:
- The markdown source code is a big long and ugly.
Then we started extending that idea to other areas, e.g. we're now using ***
(=strong>em) for menus and GUI labels:
Launch Applications ▸ Utilities ▸ Calculator and then press the OK button.
This displays nicely in any markdown environment, and with a custom css we're giving them a button-like appearance.
from markdown-it-kbd.
Related Issues (7)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from markdown-it-kbd.