unified

Project: shivjm/remark-extensions

Package: micromark-extension-kbd-nested@0.5.0

  1. micromark extension for kbd element syntax with nesting, escaping & configurable delimiter
  1. markdown 152
  2. micromark 36
  3. kbd 2
  4. keyboard 2

micromark-extension-kbd-nested

Build Downloads Size

micromark extension to support kbd element syntax with configurable delimiters, escaping, var sequences, and arbitrary nesting (e.g. Ctrl + key).

Docs at shivjm.github.io/remark-extensions.

Install

This package is ESM only: Node 18+ is needed to use it and it must be imported instead of required.

npm:

npm install micromark-extension-kbd-nested

Use

import {micromark} from 'micromark'
import {
  html,
  syntax
} from 'micromark-extension-kbd-nested';

const output = micromark('Press ||| ||Ctrl|| + || \| || |||, then || //key// ||.', {
  extensions: [syntax()],
  htmlExtensions: [html]
})

console.log(output)

Yields:

<p>Press <kbd><kbd>Ctrl</kbd> + <kbd>|</kbd></kbd>, then <kbd><var>key</var></kbd>.</p>

Syntax

Keyboard sequences

Recognizes any sequence of two or more unescaped occurrences of delimiter (defaults to |) as a keyboard sequence.

Variable sequence

variableDelimiter (defaults to /) can be used within keyboard sequences to mark variable sections.

API

This package exports the following identifiers: html, syntax. There is no default export.

html

Extension for micromark to compile as <kbd> and <var> elements (can be passed in htmlExtensions).

syntax(options?)

Returns an extension for micromark to parse keyboard sequences optionally containing variable sequences (can be passed in extensions).

Do not pass characters that are already being processed specially as the delimiters.

options

NameDescriptionDefault
delimiterCharacter to use as delimiter`
variableDelimiterCharacter to use as variable delimiter/

License

ISC © Shiv Jha Mathur