Skip to content
markdown-it plugin for keystrokes. Renders [[x]] as <kbd>x</kbd>
JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
testdata
.babelrc
.eslintrc.yml
.gitignore
.renovaterc.json
.travis.yml
CHANGELOG.md
LICENSE
README.md
bower.json
index.js
package-lock.json
package.json
test.js

README.md

markdown-it-kbd Build Status npm version Bower version

markdown-it plugin for keystrokes

Renders [[x]] as <kbd>x</kbd>. (<kbd> is the tag for keystrokes).

Usage

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.

Parsing notes

The end tag ]] must be on the same line as the start tag [[.

The combinations “[[” and “]]” are not allowed within keystroke tags. If you need to use them, use the HTML escape sequence “&#91;&#91;” for “[[” or “&#93;&#93;” for “]]”.

You can’t perform that action at this time.