npm 包 mc-highlight.js 使用教程

在进行 Web 前端开发时,使用代码高亮的工具是很普遍的方式。而 mc-highlight.js 是一个可以将代码渲染为彩色的 JS 库,能够很好的满足开发需求。本文将详细介绍如何在项目中使用 mc-highlight.js。

安装

使用 npm 安装 mc-highlight.js

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

快速上手

在项目中引入 mc-highlight.js,并绑定需要高亮的代码块。

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

其中 class 属性 lang-html, lang-csslang-javascript 是用于指定高亮语言的。

代码中最后的 script 标签是用来绑定需要高亮的代码块的。需要注意的是,由于高亮代码渲染消耗资源较大,需要在所有需要渲染的代码块都加载完毕之后再执行绑定。

可用的语言声明

mc-highlight.js 支持绑定的语言有:

  • xml
  • html
  • mathml
  • svg
  • css
  • javascript
  • typescript
  • json
  • less
  • scss
  • sql
  • makefile
  • perl
  • python
  • ruby
  • bash
  • coffeescript
  • diff
  • http
  • ini
  • markdown
  • php
  • yaml

绑定特定语言时,只需要在代码块的 class 属性中添加对应的语言即可。

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

自定义样式

mc-highlight.js 默认提供了一种主题样式,但我们也可以自定义代码块的样式。

在需要自定义样式的 CSS 中覆盖对应的 class 属性即可,例如:

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

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

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

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

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

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

进阶

为了更好的了解如何使用 mc-highlight.js,我们可以试一下以下的例子。在这个例子中我们使用 AJAX 从 Github 上获取代码并高亮显示。

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

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

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

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

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

本例中我们通过 AJAX 请求获取了 Github 上发布的 mc-highlight 包含的代码,并且灵活使用了 CSS 中的 flex 属性来实现代码块的自适应布局。此外,我们也展示了如何使用 JavaScript 来渲染高亮代码。

总结

在 Web 前端开发中,选择一个好用的代码高亮库非常重要。本文详细介绍了如何在项目中使用 mc-highlight.js 包,其中涉及了安装、快速上手、语言声明、自定义样式和进阶使用等方面,可以帮助读者更灵活、方便、高效地使用代码高亮功能。

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


猜你喜欢

  • npm 包 campfire-material-colors 使用教程

    前言 在前端开发中,颜色的选择是非常重要的一项工作。如果你曾经被长长的十六进制颜色代码所困扰,那么可以考虑使用 campfire-material-colors 这个 npm 包。

    2 年前
  • npm 包 react-styled-img 使用教程

    在前端开发中,图片是不可或缺的部分,而经常需要给图片添加样式来实现特定效果。为了方便开发,在这里介绍一个 npm 包 react-styled-img,它可以帮助我们更方便地给图片添加样式。

    2 年前
  • npm 包 installthe 使用教程

    什么是 npm 包 npm 是 Node.js 的官方包管理器,用于帮助开发者分享、发现和使用 Node.js 模块。npm 以包(package)作为单位,包含着 Node.js 模块和应用程序。

    2 年前
  • npm 包 vue-muti-dropdown 使用教程

    前言 vue-muti-dropdown 是一个基于 Vue.js 的下拉菜单组件,它支持多选、单选、搜索、分组等功能。使用这个组件可以极大地提高开发效率和用户体验。

    2 年前
  • npm 包 vue-multiple-dropdown 使用教程

    什么是 vue-multiple-dropdown vue-multiple-dropdown 是一个基于 Vue.js 的下拉框组件,可以实现多选、搜索、多级数据等功能。

    2 年前
  • npm 包 wim-security-pack-test 使用教程

    随着互联网技术的不断升级,安全性成为了一个必须要关注的问题。在前端开发领域中,一个好的安全性包可以保证我们的 web 应用程序更加健壮、更加安全。而 npm 包 wim-security-pack-t...

    2 年前
  • npm 包 html2react-loader 使用教程

    在前端开发中,我们经常需要使用 HTML 标记和以此为基础开发前端组件。但是,在 React 开发中,我们通常采用了 JSX,所以常常遇到将 HTML 转化为 React 组件的需求。

    2 年前
  • npm 包 cerebro-youdao 使用教程

    什么是 cerebro-youdao? cerebro-youdao 是一个 npm 包,它提供了一个 cerebro 插件,使您可以在 cerebro 中使用有道翻译 API 进行翻译。

    2 年前
  • npm 包 dmgapp-cli 使用教程

    在前端开发中,经常需要使用到一些桌面应用程序,如 Electron 程序。而当我们需要将这些程序发布给用户时,常常需要将应用程序打包为 dmg 文件。dmgapp-cli 是一个 Node.js 模块...

    2 年前
  • npm 包 generator-nithin-angular 使用教程

    随着前端技术的不断发展,越来越多的前端开发者开始使用 npm 包来提高开发效率。在这些 npm 包中,generator-nithin-angular 可以帮助我们快速生成 Angular.js 项目...

    2 年前
  • npm 包 koa-proxy-ext 使用教程

    背景 在进行前端开发的过程中,我们常常需要使用到代理工具,通过代理工具将后端接口转发到前端的开发服务器上,方便我们在本地开发、调试和测试前端页面。目前使用比较广泛的代理工具有浏览器插件类似的 swit...

    2 年前
  • npm 包 egg-view-vue-ssr-es7 使用教程

    介绍 egg-view-vue-ssr-es7 是一个基于 Vue.js 的服务器渲染插件,可以集成到 Egg.js 的应用程序中进行使用。它能够提供更快的页面加载速度,更好的 SEO 和更好的用户体...

    2 年前
  • npm 包 ember-cli-deploy-zip-dist 使用教程

    简介 本文介绍了如何使用 npm 包 ember-cli-deploy-zip-dist 及其相关工具来打包和部署 Ember.js 应用程序。Ember.js 是一个流行的前端 JavaScript...

    2 年前
  • npm 包 kuro-cli 使用教程

    前言 随着前端技术的发展,前端开发难度逐渐增加。如今,前端开发需要掌握众多的技能点,包括框架、工具等等。对于一些新手或者有一定经验的开发者来说,这种压力和学习成本也是一大挑战。

    2 年前
  • npm 包 arabic-antd-mobile 使用教程

    本文将介绍一个有深度、有学习价值的前端技术:npm 包 arabic-antd-mobile 的使用教程。arabic-antd-mobile 是一个面向阿拉伯语国家开发的基于 React 和 Ant...

    2 年前
  • npm 包 unicodedigits 使用教程

    什么是 unicodedigits? unicodedigits 是一个 npm 包,主要用于将数字转换为 Unicode 字符,它支持超过 200 种语言的数字转换。

    2 年前
  • npm 包 retilt 使用教程

    什么是 retilt? retilt 是一个用来管理页面倾斜效果的 npm 包,它能够帮助开发者轻松地控制页面倾斜、旋转和平移等效果,使页面视觉更加丰富和动态。 如何使用 retilt? 安装 要使用...

    2 年前
  • npm 包 atlona-matrix 使用教程

    atlona-matrix 是一个 Node.js 的 npm 包,它可以帮助我们快速连接和控制 Atlona 的矩阵视频路由器。该路由器可以将多个输入设备连接到多个输出设备上,并控制路由转换。

    2 年前
  • npm 包 ivia 使用教程

    什么是 ivia ivia 是一个基于 Vue.js 的交互式数据可视化工具,它可以帮助前端开发者快速搭建数据可视化应用,还支持多种可视化类型和交互方式。 安装和使用 安装 ivia 很简单,只需要在...

    2 年前
  • npm 包 jquery.sparrow 使用教程

    前言 jQuery 是前端开发中最为流行的 JavaScript 库之一。相信作为前端开发人员,大家都使用过它。而 jquery.sparrow 是一个基于 jQuery 的扩展插件,提供了更加便捷的...

    2 年前

相关推荐

    暂无文章