Installations

npm install remark-kbd-plus

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=4

Node Version

13.7.0

NPM Version

6.13.6 Score

68.7

Supply Chain

99.3

Quality

75.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

13

Total

14

Closed

1

Issues

Open

1

Total

1

Closed

0

Releases

Unable to fetch releases

Contributors

1

Unable to fetch Contributors

View all 1 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

twardoch

Download Statistics

Total Downloads

1,724

Last Day

1

Last Week

5

Last Month

24

Last Year

508

GitHub Statistics

2 Stars

7 Commits

3 Watching

14 Branches

1 Contributors

Bundle Size

941.00 B

Minified

558.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

1.0.20

Package Id

remark-kbd-plus@1.0.20

Unpacked Size

8.57 kB

Size

3.30 kB

File Count

5

NPM Version

6.13.6

Node Version

13.7.0

Total Downloads

Cumulative downloads

Total Downloads

1,724

Last day

0%

1

Compared to previous day

Last week

-66.7%

5

Compared to previous week

Last month

-63.6%

24

Compared to previous month

Last year

8.5%

508

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

is-whitespace-character

Dev Dependencies

13

@babel/cli @babel/core @babel/preset-env cross-env dedent del-cli eslint jest rehype-stringify remark-custom-blocks remark-parse remark-rehype remark-stringify

Versions

remark-kbd-plus

This JS plugin for remark parses custom Markdown syntax to handle keyboard keys in the format ++Cmd+Alt+M++ similar to used in the Python Markdown extension pymdownx.

It adds a new node type to the mdast produced by remark: kbd. While pymdownx.keys itemizes the single keys and allows creation of nested objects, remark-kbd-plus currently places the strings wrapped in ++ into one kbd node. If you are using rehype, the stringified HTML result will be <kbd>.

Syntax

1Hit ++Enter++ twice to create a new paragraph.

AST (see mdast specification)

Kbd (Parent) represents a reference to a user.

1interface Kbd <: Parent {
2  type: "kbd";
3}

For example, the following markdown:

++Cmd+Alt+M++

Yields:

1{
2  type: 'kbd',
3  children: [{
4    type: 'text',
5    value: 'Cmd+Alt+M'
6  }]
7}

Rehype

This plugin is compatible with rehype. Kbd mdast nodes will become <kbd>Cmd+Alt+M</kbd>.

Installation

npm:

1npm install remark-kbd-plus

Usage

Dependencies:

1const unified = require('unified')
2const remarkParse = require('remark-parse')
3const stringify = require('rehype-stringify')
4const remark2rehype = require('remark-rehype')
5
6const remarkKbd = require('remark-kbd-plus')

Usage:

1unified()
2  .use(remarkParse)
3  .use(remarkKbd)
4  .use(remark2rehype)
5  .use(stringify)

Changelog

2019-04-14

Copyright

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

41 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-01-20

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More