在前端开发中，常常需要将Markdown格式的文本转换为HTML格式。而在TypeScript或JavaScript项目中，我们可以使用marked这个工具库来实现这个功能。但是在使用marked时，如果没有声明相应的类型，就会导致无法进行类型检查，增加项目的维护难度。因此，我们需要使用@types/marked这个npm包，来为marked添加类型声明。本文将详细介绍@types/marked的使用方法。
安装
首先，我们需要安装@types/marked。在命令行中执行以下命令：
npm install --save-dev @types/marked
这将会把@types/marked这个npm包安装到我们的项目中。
引入
安装完成后，在我们的TypeScript或JavaScript文件中，我们就可以正常使用marked了。但是，在使用前，需要先引入类型声明。在代码开头添加以下语句：
import * as marked from 'marked';
这会告诉编译器，我们将使用marked这个工具。
使用
下面，我们就可以调用marked提供的方法，将Markdown文本转换为HTML格式了。marked提供了多种选项，以便我们根据需要定制转换规则。以下是一个简单的示例：
import * as marked from 'marked'; const input = '# Markdown转HTML\n\n这是一段`Markdown`文本。'; const html = marked(input); console.log(html);
这会在控制台中输出以下内容：
<h1 id="markdown%E8%BD%AChtml">Markdown转HTML</h1> <p>这是一段<code>Markdown</code>文本。</p>
如你所见，marked已经将Markdown文本解析为了对应的HTML格式。
选项
marked提供了多种选项，以便我们根据需要定制转换规则。以下是一些常用的选项：
gfm：启用GitHub Flavored Markdown扩展。breaks：启用以换行符（\n）作为换行的扩展。sanitize：启用HTML标签的过滤。smartLists：启用智能列表。
下面是一个示例，演示如何使用选项：
-- -------------------- ---- ------- ------ - -- ------ ---- --------- ----- ----- - -- ------------------------------------ ----- ---- - ------------- - ---- ----- ------- ----- --------- ----- ----------- ---- --- ------------------
这会输出以下内容：
<h1 id="markdown%E8%BD%AChtml">Markdown转HTML</h1> <p>这是一段<code>Markdown</code>文本。</p>
结束语
使用@types/marked，我们可以增加项目的代码可读性和可维护性。因为类型声明可以为我们的代码提供良好的文档和代码提示。同时，marked提供的选项也可以帮助我们根据需要定制转换规则。希望本文能对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/99327