Detalhes do pacote

markdown-it-kbd

jGleitz2.2kMIT3.0.0

Markdown-it syntax add-on for keystrokes. Renders [[x]] as <kbd>x</kbd>

markdown-it, markdown-it-plugin, keystroke, kbd

readme (leia-me)

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.

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 (&#91 for [ or &#93; for ]).

changelog (log de mudanças)

Changelog

This project adheres to Semantic Versioning.

3.0.0 (2025-04-01)

chore

  • require Node.JS >=v20, test against v20-v23 (88b2d8a)

BREAKING CHANGES

  • This package now requires Node.JS >= v2

2.2.2 (2021-03-06)

Bug Fixes

  • declare MIT licence in package.json (ea7d28b)

2.2.1 (2021-03-06)

Bug Fixes

  • licence: re-license under MIT (050926e)

2.2.0 (2020-07-06)

Features

  • support escaping delimiters with a backslash (54fc12f)
  • support nested keystroke tags (074f7f0), closes #95

2.1.0 (2020-07-06)

Bug Fixes

  • only require Node.JS >= 6 (75fece5)

Features

  • publish Typescript types (ce9ac56)

2.0.0 (2018-11-29)

Deprecated

  • Deprecate Node.JS 4 and require Node.JS >= 6

    Fixed

  • Update all packages and eliminate dependency versions with known security issues

1.1.1 (2017-11-22)

Fixed

  • Fix for the death loop that occurred if an opening tag was present without a following line break or closing tag (thanks to yamash723!)

1.1.0 (2017-01-03)

Added

1.0.0 (2016-11-06)

  • Initial release.