npm 包 @gerhobbelt/markdown-it-kbd 使用教程

前言

在前端开发中，我们经常会需要对键盘输入的内容做一些标记。比如说在一个教程中讲解快捷键时，希望将组合键用特殊样式标记出来，以便读者更容易理解。此时，我们可以使用@gerhobbelt/markdown-it-kbd npm包来帮助我们实现这一需求。

包介绍

@gerhobbelt/markdown-it-kbd 是一个markdown插件，能够将键盘输入内容用<kbd>标签</kbd>进行显示。因为它是一个markdown插件，所以对于我们使用markdown编写的文本、教程、博客等内容，它非常的适用。

安装

使用npm安装该包

npm install @gerhobbelt/markdown-it-kbd

使用方法

引入包

const md = require('markdown-it')();

const kbd = require('@gerhobbelt/markdown-it-kbd');

md.use(kbd);

语法

包含在<kbd>中的键，使用逗号（,）分隔。如果是组合键，则使用加号（+）分隔。

按下<kbd>Ctrl,C</kbd>可以复制文本

效果

按下<kbd>Ctrl,C</kbd>可以复制文本

总结

@gerhobbelt/markdown-it-kbd 是一个非常实用的markdown插件，能够大幅提高我们编写和阅读键盘输入相关内容的效率。希望通过本文的介绍，大家能够学会如何使用它，并在自己的工作中得到应用。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f02c870403f2923b035bd84