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

Markdown是一种轻量级的标记语言,通常用于编写技术文档和博客文章。随着网页应用程序的发展,许多前端开发人员选择使用Markdown来编写文档、注释和博客文章。但是,Markdown中的HTML代码可以导致安全漏洞和跨站点脚本攻击。为了避免这些问题,我们可以使用@gerhobbelt/markdown-it-sanitizer npm包,这是一种安全的Markdown渲染器,可以过滤掉危险的HTML代码和JavaScript。

安装

要使用@gerhobbelt/markdown-it-sanitizer npm包,您需要先安装Node.js和npm。安装完成后,您可以在终端中使用以下命令安装@gerhobbelt/markdown-it-sanitizer:

--- ------- ---------------------------------

用法

要使用@gerhobbelt/markdown-it-sanitizer,您需要先导入它:

----- -- - -------------------------
----- --------- - ---------------------------------------------

----------------- - -- ------- -- ---

然后,您可以像往常一样使用markdown-it来渲染Markdown文本。@gerhobbelt/markdown-it-sanitizer将在渲染时自动过滤掉危险的HTML代码和JavaScript。

例如,以下代码将渲染Markdown文本,并将其作为HTML添加到一个div元素中:

----- -- - -------------------------
----- --------- - ---------------------------------------------

----------------- - -- ------- -- ---

----- ------------ - -- ------ ------------------------------------
----- ---- - ------------------------

----- --------- - -------------------------------------
------------------- - -----

选项

@gerhobbelt/markdown-it-sanitizer支持以下选项:

  • allowedTags:一组允许的HTML标记。默认情况下,它包括a、abbr、b、blockquote、code、del、dd、div、dl、dt、em、h1、h2、h3、h4、h5、h6、hr、i、img、kbd、li、ol、p、pre、s、strike、strong、sub、sup、ul、br、ulink和span。
  • allowedAttributes:一组允许的HTML属性。默认情况下,它包括href、src、align、alt、title、width、height、class、name、target、rel、id、lang、dir、cite、datetime、style和xml:lang。

例如,以下代码使用allowedTags选项来限制允许的HTML标记:

----- -- - -------------------------
----- --------- - ---------------------------------------------

----------------- -
  ------------ - ---- ---- ----- --------- --- -
---

效果示例

以下是一个示例Markdown文本:

- ------ ----------------------------------

---- -- - -------- -----
---- -- -- ------------ -----
---- -- - --------------------------------
---- -- -- ---- ---------------------------------------------------------------------------------------- ----------- ----- ---
---- -- - --------------------- -------------------

Markdown-it将该文本转换为以下HTML:

---------- ---------------------------------------

------- -- - --------------------- -----
---- -- -- ------------------- -----
---- -- - -- ----------------------------------------
---- -- -- ---- ---------------------------------------------------------------------------------------- ----------- -------
---- -- - -----

注意,


猜你喜欢

  • npm 包 css-blank-pseudo 使用教程

    在前端开发中,我们常常会使用伪元素来实现一些特殊样式效果。不过,有时候我们需要创建一个空伪元素,这时候就需要用到 css-blank-pseudo 这个 npm 包了。

    4 年前
  • 使用 CSS-Has-Pseudo 包进行 CSS 伪类选择器的编写与应用

    在前端开发中,伪类选择器是经常会用到的一种 CSS 选择器,但是它们的语法比较特殊,相对来说有一定的学习门槛。而 CSS-Has-Pseudo 包就是针对这个问题开发出来的一种工具包,可以帮助我们更加...

    4 年前
  • npm 包 @csstools/sass-import-resolve 使用教程

    什么是 @csstools/sass-import-resolve @csstools/sass-import-resolve 是一个 npm 包,其作用是让 Sass 函数中的 @import 指令...

    4 年前
  • npm 包 css-prefers-color-scheme 使用教程

    在现代 Web 开发中,前端开发人员需要在不同设备和浏览器上实现一致的外观和体验。随着暗黑模式的流行,许多浏览器开始支持媒体查询 prefers-color-scheme。

    4 年前
  • npm 包 postcss-double-position-gradients 使用教程

    在 Web 前端开发中,CSS 是不可或缺的一部分,因为它能让我们美化页面,提高用户体验。在 CSS 中,background-image 是一个很常用的属性,而 background-image 中...

    4 年前
  • npm 包 @logux/eslint-config 使用教程

    背景 在前端开发中,代码的规范性和标准化是非常重要的,而 ESLint 是一款可以帮助我们检测代码规范性的工具。@logux/eslint-config 是一款基于 Logux 团队的代码规范进行封装...

    4 年前
  • npm 包 eslint-plugin-import-helpers 使用教程

    随着 JavaScript 项目的不断增多,代码质量的管理成为前端开发的一个非常重要的问题。其中之一便是代码风格的保持一致性,以保证代码的可读性和可维护性。而 eslint 是目前最为流行的 Java...

    4 年前
  • npm 包 @stylelint/postcss-css-in-js 使用教程

    在前端开发中,样式表是不可或缺的一部分,它们决定了我们的网页、应用程序等外观和交互方式。然而,在实际开发中,CSS处理起来并不容易,因为它有许多复杂的规则。这导致开发者的代码难以维护和扩展。

    4 年前
  • npm 包 @stylelint/postcss-markdown 使用教程

    在前端开发中,样式的一致性非常重要。为了确保代码的质量和可维护性,我们通常使用 linters 来规范我们的代码。而其中一个比较好的 lint 工具是 stylelint,它可以帮助我们保证样式表的一...

    4 年前
  • npm 包 prettier-plugin-packagejson 使用教程

    在前端开发中,我们经常使用 JSON 格式的配置文件。这些配置文件可以是 package.json、.babelrc、.eslintrc 等等。但是,我们有时会因为格式不统一,或者是因为书写方式不一致...

    4 年前
  • npm 包 @stylelint/prettier-config 使用教程

    前言 在前端的开发过程中,代码风格的统一是非常重要的,它能保证代码的易读性和一致性。而在代码风格的统一中,stylelint 和 prettier 是最常用的工具。

    4 年前
  • npm 包 @stylelint/remark-preset 使用教程

    在前端开发中,代码规范是非常重要的。代码规范的好坏,不仅可以决定代码的易读性、维护性,还会影响到开发效率,因此很多公司和团队都制定了自己的代码规范,并在开发中按照规范进行统一化管理。

    4 年前
  • npm 包 @types/global-modules 使用教程

    什么是 @types/global-modules? 在使用 Node.js 进行开发时,我们常常需要使用一些全局安装的 npm 包,如 npm、yarn、vue-cli 等等。

    4 年前
  • npm 包 @types/globjoin 使用教程

    在前端开发中,很多时候我们需要对文件进行操作,比如查找,读取,修改等等。而 glob 是一个强大的文件查找工具,可以用来匹配符合模式的文件路径。而 @types/globjoin 就是一个 TypeS...

    4 年前
  • npm 包 github-contributors-list 使用教程

    引言 在开发各种前端应用程序时,我们往往会使用一些开源组件或者库。而这些组件和库常常都托管在 Github 上,在使用它们的过程中,了解这些组件和库的开发历程和贡献者也是非常重要的。

    4 年前
  • NPM包babel-preset-current-node-syntax使用教程

    前言 随着Node.js的迅速发展,许多开发者都开始使用Node.js构建Web应用程序。然而,不同版本的Node.js在语言语法上会存在差异,而babel-preset-current-node-s...

    4 年前
  • npm 包 mdast-util-heading-style 使用教程

    在前端领域中,Markdown 已成为一种广泛使用的文本格式语言。在 Markdown 编写中,经常使用的就是标题。但是在一些不同的 Markdown 编辑器或渲染器中,对于标题的样式有不同的规定。

    4 年前
  • npm 包 @types/hast 使用教程

    前言 在前端开发中,我们经常需要处理 HTML 文档。而解析 HTML 文档是一项复杂且容易出错的任务。因此,为了提高开发效率和代码的可靠性,我们通常使用一些工具来帮助我们解析 HTML 文档。

    4 年前
  • npm 包 spooks 使用教程

    前言 在前端开发中,我们经常会用到各种第三方库和框架来提高开发效率。而 npm 是 Node.js 的包管理器,也是前端开发中最流行的包管理工具之一。在 npm 中,可以找到大量优秀的工具和模块,方便...

    4 年前
  • npm 包 @debitoor/eslint-config-debitoor 使用教程

    在前端开发中,代码规范是非常重要的,它能够提升代码的可维护性、可读性以及降低出错的概率。而 eslint 工具就是为了解决这个问题而生的,它能够检查代码,发现潜在的问题,并根据配置文件进行提示或者自动...

    4 年前

相关推荐

    暂无文章