Skip to content

Latest commit

 

History

History
132 lines (89 loc) · 3.7 KB

README.md

File metadata and controls

132 lines (89 loc) · 3.7 KB
Raw

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.

  • All is preserved except immediately after an opening sequence or immediately before a closing sequence.
  • Nesting is possible by using a longer sequence on the outside and a shorter sequence on the inside, e.g. ||| ||Ctrl|| + ||x|| ||| will be turned into Ctrl + x.
  • The opening sequence will be considered to end at the first whitespace character or non-delimiter, including escape characters. For example, these will all produce <kbd>|</kbd>:
    • ||\|||
    • || | ||
    • || | ||
    • ++|++ (with a delimiter of +)
    • ++ | ++ (with a delimiter of +)

Variable sequence

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

  • Must always use two variable delimiters.
  • Cannot be nested.
  • All is preserved except immediately after an opening sequence or immediately before a closing sequence.

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

Name Description Default
delimiter Character to use as delimiter `
variableDelimiter Character to use as variable delimiter /

License

ISC © Shiv Jha Mathur