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

在前端开发中,经常需要将代码段呈现在页面上进行展示或解释。而 @gerhobbelt/markdown-it-samp 是一款能够简单易用地在 Markdown 中呈现代码样式的 npm 包,本文将详细介绍如何使用该包。

安装

使用 npm 安装 @gerhobbelt/markdown-it-samp:

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

使用

使用 @gerhobbelt/markdown-it-samp 需要两个步骤:安装插件和使用插件。

安装插件

我们可以使用以下代码来安装插件:

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

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

使用插件

安装完成后,我们就可以使用插件来呈现代码段。例如,要呈现以下 Markdown 代码:

------

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

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

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

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

输出:

------

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

如此一来,我们就成功地将代码端呈现在页面上了。

支持的语言

当前,@gerhobbelt/markdown-it-samp 支持以下语言:

  • JS
  • HTML
  • XML
  • SVG
  • Bash
  • SQL
  • Markdown

如果想添加其他语言支持,可以在初始化时通过 options 配置:

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

其中,langPrefix 和 allowedLang 分别为语言前缀和允许的语言数组。这里,我们添加了一个叫做“your-language”的新语言。

总结

经过本文的介绍,我们已经学会了如何使用 @gerhobbelt/markdown-it-samp 在 Markdown 中呈现代码样式,并且添加了对其他语言的支持。这对于前端开发来说是一个很有用的工具,也是有很大指导意义的。

完整示例代码:

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

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

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

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

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

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5f02c870403f2923b035bd8c


猜你喜欢

  • 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 年前
  • NPM 包 @webpack-utilities/test 使用教程

    前言 在前端开发过程中,我们经常需要使用一些工具来方便我们的开发,提高开发效率,其中大名鼎鼎的 Webpack 就是前端开发中最重要的工具之一。@webpack-utilities/test 是一个 ...

    4 年前
  • NPM包@verdaccio/commons-api使用教程

    介绍 @verdaccio/commons-api是一个通用的API库,提供了一些用于编写简单NPM插件的API。包括插件编写、插件验证、插件错误处理以及插件命令行工具的处理等。

    4 年前
  • npm 包 cordova-app-hello-world 使用教程

    介绍 cordova-app-hello-world 是一个基于 Cordova 开发的 HTML5 移动应用程序开发框架,它提供了可靠的原生设备感应和用户界面元素集成。

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

    如果你是前端开发者,那么你一定知道 ESLint 这个工具。它是一个静态代码分析工具,可以帮助开发者避免一些常见的错误,并规范团队中代码风格的一致性。而本文要介绍的是一个名为 @cordova/esl...

    4 年前
  • npm 包 `encode-utf8` 使用教程

    encode-utf8 是一款基于 JavaScript 的 npm 包,用于将字符串编码为 UTF-8 格式,同时支持对一个 UTF-8 格式的字符串进行解码。它可以满足前端开发人员在处理 Unic...

    4 年前
  • npm 包 selenium-mock 使用教程

    简述 selenium-mock 是一个 npm 包,用于模拟 Selenium WebDriver 的行为,灵活地控制浏览器的行为和响应。通过将 selenium-mock 引入到项目中,可以极大地...

    4 年前

相关推荐

    暂无文章