Press Ctrl + |, then key.
\n```" + }, + { + "kind": "text", + "text": "\n\n## Syntax\n\n### Keyboard sequences\nRecognizes any sequence of two or more unescaped occurrences of\n" + }, + { + "kind": "code", + "text": "`delimiter`" + }, + { + "kind": "text", + "text": " (defaults to " + }, + { + "kind": "code", + "text": "`|`" + }, + { + "kind": "text", + "text": ") as a keyboard sequence.\n \n* All is preserved except immediately after an opening sequence or\n immediately before a closing sequence.\n* Nesting is possible by using a longer sequence on the outside and a\n shorter sequence on the inside, e.g. " + }, + { + "kind": "code", + "text": "`||| ||Ctrl|| + ||x|| |||`" + }, + { + "kind": "text", + "text": " will\n be turned into Ctrl + x.\n* The opening sequence will be considered to end at the first\n whitespace character or non-delimiter, including escape characters.\n For example, these will all produce " + }, + { + "kind": "code", + "text": "`|`" + }, + { + "kind": "text", + "text": ":\n * " + }, + { + "kind": "code", + "text": "`||\\|||`" + }, + { + "kind": "text", + "text": "\n * " + }, + { + "kind": "code", + "text": "`|| | ||`" + }, + { + "kind": "text", + "text": "\n * " + }, + { + "kind": "code", + "text": "`|| | ||`" + }, + { + "kind": "text", + "text": "\n * " + }, + { + "kind": "code", + "text": "`++|++`" + }, + { + "kind": "text", + "text": " (with a delimiter of " + }, + { + "kind": "code", + "text": "`+`" + }, + { + "kind": "text", + "text": ")\n * " + }, + { + "kind": "code", + "text": "`++ | ++`" + }, + { + "kind": "text", + "text": " (with a delimiter of " + }, + { + "kind": "code", + "text": "`+`" + }, + { + "kind": "text", + "text": ")\n \n### Variable sequence\n" + }, + { + "kind": "code", + "text": "`variableDelimiter`" + }, + { + "kind": "text", + "text": " (defaults to " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": ") can be used *within* keyboard\nsequences to mark variable sections.\n\n* Must always use two variable delimiters.\n* Cannot be nested.\n* All is preserved except immediately after an opening sequence or\n immediately before a closing sequence.\n\n## API\n\nThis package exports the following identifiers: " + }, + { + "kind": "code", + "text": "`html`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`syntax`" + }, + { + "kind": "text", + "text": ".\nThere is no default export.\n\n### " + }, + { + "kind": "code", + "text": "`html`" + }, + { + "kind": "text", + "text": "\n\nExtension for micromark to compile as " + }, + { + "kind": "code", + "text": "``" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "``" + }, + { + "kind": "text", + "text": " elements\n(can be passed in " + }, + { + "kind": "code", + "text": "`htmlExtensions`" + }, + { + "kind": "text", + "text": ").\n\n### " + }, + { + "kind": "code", + "text": "`syntax(options?)`" + }, + { + "kind": "text", + "text": "\n\nReturns an extension for micromark to parse keyboard sequences\noptionally containing variable sequences (can be passed in\n" + }, + { + "kind": "code", + "text": "`extensions`" + }, + { + "kind": "text", + "text": ").\n\nDo not pass characters that are already being processed specially as\nthe delimiters.\n\n#### " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": "\n\n| Name | Description | Default |\n|------|-------------|---------|\n| " + }, + { + "kind": "code", + "text": "`delimiter`" + }, + { + "kind": "text", + "text": " | Character to use as delimiter | " + }, + { + "kind": "code", + "text": "`|`" + }, + { + "kind": "text", + "text": " |\n| " + }, + { + "kind": "code", + "text": "`variableDelimiter`" + }, + { + "kind": "text", + "text": " | Character to use as variable delimiter | " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " |\n\n## License\n\n[ISC][license] © [Shiv Jha Mathur][author]\n\n\n\n[author]: https://github.com/shivjm\n\n[test-badge]: https://github.com/shivjm/remark-extensions/actions/workflows/test.yml/badge.svg\n\n[build]: https://github.com/shivjm/remark-extensions/actions\n\n[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-kbd-nested.svg\n\n[downloads]: https://www.npmjs.com/package/micromark-extension-kbd-nested\n\n[size-badge]: https://img.shields.io/bundlephobia/minzip/micromark-extension-kbd-nested.svg\n\n[size]: https://bundlephobia.com/result?p=micromark-extension-kbd-nested\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[license]: ../../license\n\n[micromark]: https://github.com/micromark/micromark\n\n[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown\n\n[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown\n\n[remark]: https://github.com/remarkjs/remark" + } + ], + "symbolIdMap": { + "0": { + "sourceFileName": "src/index.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "src/index.ts", + "qualifiedName": "normalizeDelimiter" + }, + "2": { + "sourceFileName": "src/index.ts", + "qualifiedName": "normalizeDelimiter" + }, + "3": { + "sourceFileName": "src/index.ts", + "qualifiedName": "delimiter" + }, + "4": { + "sourceFileName": "src/index.ts", + "qualifiedName": "defaultValue" + }, + "5": { + "sourceFileName": "src/index.ts", + "qualifiedName": "IOptions" + }, + "6": { + "sourceFileName": "src/index.ts", + "qualifiedName": "IOptions.delimiter" + }, + "7": { + "sourceFileName": "src/index.ts", + "qualifiedName": "IOptions.variableDelimiter" + }, + "8": { + "sourceFileName": "src/index.ts", + "qualifiedName": "html" + }, + "9": { + "sourceFileName": "src/index.ts", + "qualifiedName": "syntax" + }, + "10": { + "sourceFileName": "src/index.ts", + "qualifiedName": "syntax" + }, + "11": { + "sourceFileName": "src/index.ts", + "qualifiedName": "options" + } + } +} \ No newline at end of file diff --git a/docs-json/remark-kbd-nested.json b/docs-json/remark-kbd-nested.json new file mode 100644 index 0000000..135bbc1 --- /dev/null +++ b/docs-json/remark-kbd-nested.json @@ -0,0 +1,454 @@ +{ + "id": 0, + "name": "remark-kbd-nested", + "variant": "project", + "kind": 1, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "[remark](https://github.com/remarkjs/remark) plugin to support\nkeyboard and variable sequences. See " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "micromark-extension-kbd-nested" + }, + { + "kind": "text", + "text": " for syntax and options.\n\n## Use\n\n" + }, + { + "kind": "code", + "text": "```js\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport { remarkKbdNested } from \"remark-kbd-nested\";\nimport remarkRehype from \"remark-rehype\";\nimport rehypeStringify from \"rehype-stringify\";\n\nmain();\n\nasync function main() {\n const file = await unified()\n .use(remarkParse)\n .use(remarkKbdNested)\n .use(remarkRehype)\n .use(rehypeStringify)\n .process(\"Press ||| ||Ctrl|| + ||//key//|| ||| to trigger the action.\");\n\n console.log(String(file));\n}\n```" + }, + { + "kind": "text", + "text": "\n\nYields:\n\n" + }, + { + "kind": "code", + "text": "```html\nPress Ctrl + key
to trigger the action.\n```" + } + ] + }, + "children": [ + { + "id": 5, + "name": "IOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options that can be passed to the extension." + } + ] + }, + "children": [ + { + "id": 6, + "name": "delimiter", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Character code or character to use as a delimiter for keyboard sequences. Defaults to " + }, + { + "kind": "code", + "text": "`|`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "sources": [ + { + "fileName": "packages/micromark-extension-kbd-nested/src/index.ts", + "line": 65, + "character": 2, + "url": "https://github.com/shivjm/remark-extensions/blob/b85d7acdb8dbf0882dfce7eb0ba16fc62bb0845d/packages/micromark-extension-kbd-nested/src/index.ts#L65" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 7, + "name": "variableDelimiter", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Character code or character to use as a delimiter for variable sequences within keyboard sequences. Defaults to " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "sources": [ + { + "fileName": "packages/micromark-extension-kbd-nested/src/index.ts", + "line": 68, + "character": 2, + "url": "https://github.com/shivjm/remark-extensions/blob/b85d7acdb8dbf0882dfce7eb0ba16fc62bb0845d/packages/micromark-extension-kbd-nested/src/index.ts#L68" + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 6, + 7 + ] + } + ], + "sources": [ + { + "fileName": "packages/micromark-extension-kbd-nested/src/index.ts", + "line": 63, + "character": 17, + "url": "https://github.com/shivjm/remark-extensions/blob/b85d7acdb8dbf0882dfce7eb0ba16fc62bb0845d/packages/micromark-extension-kbd-nested/src/index.ts#L63" + } + ] + }, + { + "id": 1, + "name": "remarkKbdNested", + "variant": "declaration", + "kind": 64, + "flags": {}, + "sources": [ + { + "fileName": "packages/remark-kbd-nested/src/index.ts", + "line": 90, + "character": 13, + "url": "https://github.com/shivjm/remark-extensions/blob/b85d7acdb8dbf0882dfce7eb0ba16fc62bb0845d/packages/remark-kbd-nested/src/index.ts#L90" + } + ], + "signatures": [ + { + "id": 2, + "name": "remarkKbdNested", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "remark plugin to convert keyboard and variable sequences into\n[rehype](https://github.com/rehypejs/rehype/)-compatible " + }, + { + "kind": "code", + "text": "``" + }, + { + "kind": "text", + "text": "\nand " + }, + { + "kind": "code", + "text": "``" + }, + { + "kind": "text", + "text": " elements respectively. See " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "micromark-extension-kbd-nested" + }, + { + "kind": "text", + "text": " for syntax and options." + } + ] + }, + "sources": [ + { + "fileName": "packages/remark-kbd-nested/src/index.ts", + "line": 90, + "character": 13, + "url": "https://github.com/shivjm/remark-extensions/blob/b85d7acdb8dbf0882dfce7eb0ba16fc62bb0845d/packages/remark-kbd-nested/src/index.ts#L90" + } + ], + "parameters": [ + { + "id": 3, + "name": "this", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts", + "qualifiedName": "Processor" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/.pnpm/@types+mdast@3.0.15/node_modules/@types/mdast/index.d.ts", + "qualifiedName": "Root" + }, + "name": "Root", + "package": "@types/mdast" + }, + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Processor", + "package": "unified" + } + }, + { + "id": 4, + "name": "settings", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5, + "name": "IOptions", + "package": "micromark-extension-kbd-nested" + } + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts", + "qualifiedName": "Transformer" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/.pnpm/@types+mdast@3.0.15/node_modules/@types/mdast/index.d.ts", + "qualifiedName": "Root" + }, + "name": "Root", + "package": "@types/mdast" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/.pnpm/@types+mdast@3.0.15/node_modules/@types/mdast/index.d.ts", + "qualifiedName": "Root" + }, + "name": "Root", + "package": "@types/mdast" + } + ], + "name": "Transformer", + "package": "unified" + } + ] + } + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 5 + ] + }, + { + "title": "Functions", + "children": [ + 1 + ] + } + ], + "packageName": "remark-kbd-nested", + "packageVersion": "0.5.2", + "readme": [ + { + "kind": "text", + "text": "# remark-kbd-nested\n\n[![Build][test-badge]][build]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n\n**[remark][]** extension to support " + }, + { + "kind": "code", + "text": "`kbd`" + }, + { + "kind": "text", + "text": " element syntax with\nconfigurable delimiters, escaping, " + }, + { + "kind": "code", + "text": "`var`" + }, + { + "kind": "text", + "text": " sequences, and arbitrary\nnesting (e.g. Ctrl + key).\n\n## Install\n\nThis package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):\nNode 12+ is needed to use it and it must be " + }, + { + "kind": "code", + "text": "`import`" + }, + { + "kind": "text", + "text": "ed instead of " + }, + { + "kind": "code", + "text": "`require`" + }, + { + "kind": "text", + "text": "d.\n\n[npm][]:\n\n" + }, + { + "kind": "code", + "text": "```sh\nnpm install micromark-extension-kbd-nested\n```" + }, + { + "kind": "text", + "text": "\n\n## Use\n\n" + }, + { + "kind": "code", + "text": "```javascript\nimport { remark } from \"remark\";\nimport { remarkKbdNested } from \"remark-kbd-nested\";\nimport remarkRehype from \"remark-rehype\";\nimport rehypeStringify from \"rehype-stringify\";\n\nconst output = remark()\n .use(remarkKbdNested)\n .use(remarkRehype)\n .use(rehypeStringify)\n .processSync(\"Press ||| ||Ctrl|| + || \\| || |||, then || //key// ||.\");\n\nconsole.log(String(output));\n```" + }, + { + "kind": "text", + "text": "\n\nYields:\n\n" + }, + { + "kind": "code", + "text": "```html\nPress Ctrl + |, then key.
\n```" + }, + { + "kind": "text", + "text": "\n\n## Syntax\n\nSee [micromark-extension-kbd-nested][].\n\n## API\n\n### " + }, + { + "kind": "code", + "text": "`remarkKbdNested(options?)`" + }, + { + "kind": "text", + "text": "\n\nReturns a remark plugin to parse keyboard sequences optionally\ncontaining variable sequences (can be passed to " + }, + { + "kind": "code", + "text": "`use`" + }, + { + "kind": "text", + "text": "). The options\nare passed directly to [micromark-extension-kbd-nested][].\n\n## License\n\n[ISC][LICENSE] © [Shiv Jha Mathur][author]\n\n[test-badge]: https://github.com/shivjm/remark-extensions/actions/workflows/test.yml/badge.svg\n\n[build]: https://github.com/shivjm/remark-extensions/actions\n\n[downloads-badge]: https://img.shields.io/npm/dm/remark-kbd-nested.svg\n\n[downloads]: https://www.npmjs.com/package/remark-kbd-nested\n\n[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-kbd-nested.svg\n\n[size]: https://bundlephobia.com/result?p=remark-kbd-nested\n\n[remark]: https://github.com/remarkjs/remark\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[micromark-extension-kbd-nested]: https://www.npmjs.com/package/micromark-extension-kbd-nested\n\n[license]: ../../license\n\n[author]: https://github.com/shivjm/" + } + ], + "symbolIdMap": { + "0": { + "sourceFileName": "src/index.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "src/index.ts", + "qualifiedName": "remarkKbdNested" + }, + "2": { + "sourceFileName": "../../node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts", + "qualifiedName": "remarkKbdNested" + }, + "3": { + "sourceFileName": "../../node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts", + "qualifiedName": "this" + }, + "4": { + "sourceFileName": "../../node_modules/.pnpm/unified@10.1.2/node_modules/unified/index.d.ts", + "qualifiedName": "settings" + }, + "5": { + "sourceFileName": "../micromark-extension-kbd-nested/src/index.ts", + "qualifiedName": "IOptions" + }, + "6": { + "sourceFileName": "../micromark-extension-kbd-nested/src/index.ts", + "qualifiedName": "IOptions.delimiter" + }, + "7": { + "sourceFileName": "../micromark-extension-kbd-nested/src/index.ts", + "qualifiedName": "IOptions.variableDelimiter" + } + } +} \ No newline at end of file diff --git a/functions/micromark_extension_kbd_nested.normalizeDelimiter.html b/functions/micromark_extension_kbd_nested.normalizeDelimiter.html new file mode 100644 index 0000000..1bf6ccc --- /dev/null +++ b/functions/micromark_extension_kbd_nested.normalizeDelimiter.html @@ -0,0 +1,5 @@ +
\ No newline at end of file
diff --git a/functions/micromark_extension_kbd_nested.syntax.html b/functions/micromark_extension_kbd_nested.syntax.html
new file mode 100644
index 0000000..6a6f6e0
--- /dev/null
+++ b/functions/micromark_extension_kbd_nested.syntax.html
@@ -0,0 +1,5 @@
+
Function syntax
- syntax(options?): Extension
Returns an extension for micromark to parse keyboard sequences +optionally containing variable sequences. Can be passed in +
+extensions.Parameters
- options: IOptions = {}
Returns Extension
Extension to parse keyboard sequences.
+
Function remarkKbdNested
- remark
Kbd Nested(this, ...settings): void | Transformer<Root, Root> remark plugin to convert keyboard and variable sequences into +rehype-compatible
+<kbd>+and<var>elements respectively. See micromark-extension-kbd-nested for syntax and options.Parameters
- this: Processor<void, Root, void, void>
Rest...settings: IOptions[]
Returns void | Transformer<Root, Root>
remark-extensions
Interface IOptions
Options that can be passed to the extension.
+ Index
Properties
Properties
Optional delimiter
delimiter?: string | number
Character code or character to use as a delimiter for keyboard sequences. Defaults to |.
Optional variable
variable
Character code or character to use as a delimiter for variable sequences within keyboard sequences. Defaults to /.
Interface IOptions
Options that can be passed to the extension.
+ Index
Properties
Properties
Optional delimiter
delimiter?: string | number
Character code or character to use as a delimiter for keyboard sequences. Defaults to |.
Optional variable
variable
Character code or character to use as a delimiter for variable sequences within keyboard sequences. Defaults to /.
Module micromark-extension-kbd-nested - v0.7.0
micromark extension to
+support kbd element syntax with configurable delimiters,
+escaping, var sequences, and arbitrary nesting (e.g.
+Ctrl + key).
Warning: Do not set delimiters to characters that already being +processed specially. This will result in undefined behaviour.
+Syntax
Keyboard sequences
Recognizes any sequence of two or more unescaped occurrences of
+delimiter (defaults to |) as a
+keyboard sequence.
-
+
- All whitespace is preserved except immediately after an opening +sequence or immediately before a closing sequence. +
- Nesting is possible using a longer sequence on the outside and a
+shorter sequence on the inside. For example,
||| ||Ctrl|| + ||x|| |||will yield 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
Recognizes sequences of two occurrences of delimiter (defaults to /) within
+keyboard sequences as mark variable sections.
-
+
- Must always use two variable delimiters. Further occurrences will be +interpreted as the closing sequence. +
- Cannot be nested. +
- All whitespace is preserved except immediately after an opening +sequence or immediately before a closing sequence. +
micromark-extension-kbd-nested
+
+
micromark extension to support kbd element syntax with
+configurable delimiters, escaping, var sequences, and arbitrary
+nesting (e.g. Ctrl + key).
Install
This package is ESM only:
+Node 12+ 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
+ + +Index
Interfaces
IOptions
+
Variables
html
+
Functions
Module remark-kbd-nested - v0.5.2
remark plugin to support +keyboard and variable sequences. See micromark-extension-kbd-nested for syntax and options.
+Use
import { unified } from "unified";
import remarkParse from "remark-parse";
import { remarkKbdNested } from "remark-kbd-nested";
import remarkRehype from "remark-rehype";
import rehypeStringify from "rehype-stringify";
main();
async function main() {
const file = await unified()
.use(remarkParse)
.use(remarkKbdNested)
.use(remarkRehype)
.use(rehypeStringify)
.process("Press ||| ||Ctrl|| + ||//key//|| ||| to trigger the action.");
console.log(String(file));
}
+Yields:
+<p>Press <kbd><kbd>Ctrl</kbd></kbd> + <kbd><var>key</var></kbd></kbd> to trigger the action.</p>
+remark-kbd-nested
+
+
remark extension to support kbd element syntax with
+configurable delimiters, escaping, var sequences, and arbitrary
+nesting (e.g. Ctrl + key).
Install
This package is ESM only:
+Node 12+ is needed to use it and it must be imported instead of required.
npm:
+npm install micromark-extension-kbd-nested
+Use
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:
+<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
+Index
Interfaces
IOptions
+
Functions
Variable htmlConst
html: HtmlExtension = ...
Extension for micromark to compile keyboard sequences as <kbd>
+elements and variable sequences as <var> elements. Can be passed
+in htmlExtensions.
Converts the optional
+delimiterinto a character code. Returns +defaultValueif no delimiter is provided.