markdown-it-kbd
Version:
Markdown-it syntax add-on for keystrokes. Renders [[x]] as <kbd>x</kbd>
22 lines (14 loc) • 1.09 kB
Markdown
# markdown-it-kbd [](https://travis-ci.org/jGleitz/markdown-it-kbd) [](https://badge.fury.io/js/markdown-it-kbd) [](https://badge.fury.io/bo/markdown-it-kbd)
> [markdown-it](https://github.com/markdown-it/markdown-it) plugin for keystrokes
Renders `[[x]]` as `<kbd>x</kbd>`. ([`<kbd>`](http://www.w3schools.com/tags/tag_kbd.asp) is the tag for keystrokes).
## Usage
```js
const md = require('markdown-it')();
const kbd = require('markdown-it-kbd');
md.use(kbd);
```
This plugin can also be used together with [`markdown-it-attrs`](https://github.com/arve0/markdown-it-attrs/).
## Syntax notes
The end tag `]]` must be on the same line as the start tag `[[`.
The characters “`[`” and “`]`” are not allowed within keystroke tags.
If you need to use them, escape them with a backslash (i.e. `\[` or `\]`) or use HTML escape sequences (`[` for `[` or `]` for `]`).