# micromark-extension-kbd-nested
> micromark extension for `kbd` element syntax with nesting, escaping & configurable delimiter
Latest version **0.7.1** (published 2024-04-23) · ISC license · 0 weekly downloads
## Install
```sh
npm install micromark-extension-kbd-nested
pnpm add micromark-extension-kbd-nested
yarn add micromark-extension-kbd-nested
bun add micromark-extension-kbd-nested
```
## Health
**Score 35/100 (D)** — status: abandoned.
Positive: esm support; no vulnerabilities; has provenance.
Warnings: low downloads; no types; pre 1.0.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 0.7.1 |
| Published | 2024-04-23 |
| First published | 2021-10-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 2 |
| Unpacked size | 35.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (Unknown) |
| GitHub stars | 0 |
| Author | Shiv Jha-Mathur |
| Maintainers | shivjm |
| Keywords | micromark, kbd, keyboard, markdown |
## Links
- npm: https://www.npmjs.com/package/micromark-extension-kbd-nested
- Repository: https://github.com/shivjm/remark-extensions
- Issues: https://github.com/shivjm/remark-extensions/issues
- npm.io page: https://npm.io/package/micromark-extension-kbd-nested
## Dependencies (2)
- [micromark-util-symbol](https://npm.io/package/micromark-util-symbol.md) ^1.0.0
- [micromark-util-character](https://npm.io/package/micromark-util-character.md) ^1.1.0
## Alternatives
- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads
## Recent versions
- 0.7.1 (latest) — 2024-04-23
- 0.7.0 — 2024-04-23
- 0.6.10 — 2024-04-23
- 0.6.9 — 2024-04-23
- 0.6.8 — 2024-04-23
- 0.6.7 — 2024-04-23
- 0.6.6 — 2024-04-23
- 0.6.5 — 2024-04-23
- 0.6.4 — 2024-04-23
- 0.6.3 — 2024-04-23
- 0.5.0 — 2021-11-10
- 0.4.0 — 2021-11-02
- 0.3.1 — 2021-11-02
- 0.3.0 — 2021-11-02
- 0.2.1 — 2021-11-01
- … 3 more at https://npm.io/package/micromark-extension-kbd-nested/versions
## README
# micromark-extension-kbd-nested
[![Build][test-badge]][build]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][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.](https://shivjm.github.io/remark-extensions/modules/micromark_extension_kbd_nested.html)
## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
Node 18+ is needed to use it and it must be `import`ed instead of `require`d.
[npm][]:
```sh
npm install micromark-extension-kbd-nested
```
## Use
```js
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:
```html
Press Ctrl + |, then key.
```
## 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 `|`:
* `||\|||`
* `|| | ||`
* `|| | ||`
* `++|++` (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 `` and `` 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][license] © [Shiv Jha Mathur][author]
[author]: https://github.com/shivjm
[test-badge]: https://github.com/shivjm/remark-extensions/actions/workflows/test.yml/badge.svg
[build]: https://github.com/shivjm/remark-extensions/actions
[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-kbd-nested.svg
[downloads]: https://www.npmjs.com/package/micromark-extension-kbd-nested
[size-badge]: https://img.shields.io/bundlephobia/minzip/micromark-extension-kbd-nested.svg
[size]: https://bundlephobia.com/result?p=micromark-extension-kbd-nested
[npm]: https://docs.npmjs.com/cli/install
[license]: ../../license
[micromark]: https://github.com/micromark/micromark
[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
[remark]: https://github.com/remarkjs/remark
---
_Source: https://npm.io/package/micromark-extension-kbd-nested · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._