# remark-kbd-nested

> remark plugin to add support for `kbd` element syntax with configurable delimiters, escaping, and arbitrary nesting

Latest version **0.6.1** (published 2024-04-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install remark-kbd-nested
pnpm add remark-kbd-nested
yarn add remark-kbd-nested
bun add remark-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.6.1 |
| Published | 2024-04-23 |
| First published | 2021-11-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (Unknown) |
| GitHub stars | 0 |
| Author | Shiv Jha-Mathur |
| Maintainers | shivjm |
| Keywords | remark, markdown, kbd, keyboard, plugin |

## Links

- npm: https://www.npmjs.com/package/remark-kbd-nested
- Repository: https://github.com/shivjm/remark-extensions
- Homepage: https://github.com/shivjm/remark-extensions#readme
- Issues: https://github.com/shivjm/remark-extensions/issues
- npm.io page: https://npm.io/package/remark-kbd-nested

## Dependencies (1)

- [micromark-extension-kbd-nested](https://npm.io/package/micromark-extension-kbd-nested.md) ^0.7.1

## 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.6.1 (latest) — 2024-04-23
- 0.6.0 — 2024-04-23
- 0.5.2 — 2024-04-23
- 0.5.1 — 2024-04-23
- 0.4.1 — 2021-11-14
- 0.4.0 — 2021-11-10
- 0.3.0 — 2021-11-02
- 0.2.1 — 2021-11-02
- 0.2.0 — 2021-11-02
- 0.1.1 — 2021-11-01

## README

# remark-kbd-nested

[![Build][test-badge]][build]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]

**[remark][]** extension to support `kbd` element syntax with
configurable delimiters, escaping, `var` sequences, and arbitrary
nesting (e.g. <kbd><kbd>Ctrl</kbd> + <kbd><var>key</var></kbd></kbd>).

[Docs at shivjm.github.io/remark-extensions.](https://shivjm.github.io/remark-extensions/modules/remark_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

```javascript
import { remark } from "remark";
import { remarkKbdNested } from "remark-kbd-nested";
import remarkRehype from "remark-rehype";
import rehypeStringify from "rehype-stringify";

const output = remark()
      .use(remarkKbdNested)
      .use(remarkRehype)
      .use(rehypeStringify)
      .processSync("Press ||| ||Ctrl|| + || \| || |||, then || //key// ||.");

console.log(String(output));
```

Yields:

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

## Syntax

See [micromark-extension-kbd-nested][].

## API

### `remarkKbdNested(options?)`

Returns a remark plugin to parse keyboard sequences optionally
containing variable sequences (can be passed to `use`). The options
are passed directly to [micromark-extension-kbd-nested][].

## License

[ISC][LICENSE] © [Shiv Jha Mathur][author]

[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/remark-kbd-nested.svg

[downloads]: https://www.npmjs.com/package/remark-kbd-nested

[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-kbd-nested.svg

[size]: https://bundlephobia.com/result?p=remark-kbd-nested

[remark]: https://github.com/remarkjs/remark

[npm]: https://docs.npmjs.com/cli/install

[micromark-extension-kbd-nested]: https://www.npmjs.com/package/micromark-extension-kbd-nested

[license]: ../../license

[author]: https://github.com/shivjm/

---
_Source: https://npm.io/package/remark-kbd-nested · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._