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

简介

@gerhobbelt/markdown-it-emoji 是基于 markdown-it 的一个 npm 包，其主要功能是让我们在 markdown 文章中使用表情符号。

安装

在进行该 npm 包的使用前，需先安装 @gerhobbelt/markdown-it-emoji。可在终端中输入以下命令进行安装：

npm install @gerhobbelt/markdown-it-emoji

使用

在安装完成后，我们需在自己的项目中引入该包。我们可以通过以下代码来使用该包：

const markdownIt = require('markdown-it');
const markdownItEmoji = require('@gerhobbelt/markdown-it-emoji');

const md = markdownIt();
md.use(markdownItEmoji);

const result = md.render('Hello 😃');

将以上代码添加到你的项目中，你所写的 markdown 文章便可以使用表情符号了，在 markdown 文章中输入😃，它就会自动转换成相应的表情符号。

支持的表情符号

@gerhobbelt/markdown-it-emoji 支持常用的表情符号如下：

自定义表情符号

我们也可以自定义表情符号的代码，只需在初始化 markdownItEmoji 时添加相关配置即可。例如：

const md = markdownIt();
md.use(markdownItEmoji, {
  defs: {
    'custom-emoji': 'path/to/custom-emoji.png'
  }
});

在上述示例中，我们自定义了一个代码为“custom-emoji”的表情符号，路径为“path/to/custom-emoji.png”。

结语

通过学习本篇文章，我们了解了 @gerhobbelt/markdown-it-emoji 的基本使用和常用的表情符号，同时也学习如何自定义表情符号。在我们的实际开发项目中，对于一些需要使用表情符号的场景，使用该 npm 包可事半功倍。

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