npm 包 @hellstad/marked 使用教程

什么是 @hellstad/marked

@hellstad/marked 是一个能够将 Markdown 文本渲染为 HTML 的 JavaScript 库,它基于 markdown.js 和 Prism.js 实现。相比普通的 markdown.js,@hellstad/marked 具备更多的语言支持和代码高亮功能。

安装

你可以使用 npm 进行安装:

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

基本使用

引入 @hellstad/marked:

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

使用 marked 渲染 Markdown 文本:

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

配置

@hellstad/marked 的配置分为两部分:

  1. markdown.js 的配置
  2. Prism.js 的配置

这里使用的是 markdown.js 的配置,具体配置项可以参考 markdown.js 的文档。

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

Prism.js 的配置可以在引入时进行配置,如下:

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

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

这里只给出示例,具体的语言支持和主题可以根据项目需求进行选择。

示例

下面是一个使用了配置项和 Prism.js 语言高亮的示例:

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

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

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

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

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

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

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

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

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

-- --

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

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

-- ----

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

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

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

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

--

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

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

输出结果:

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

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

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

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

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

小结

本文介绍了 @hellstad/marked 的基本使用和配置方法,同时给出了示例代码。也可通过查看源码来进行更深入的学习和指导。

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


猜你喜欢

  • npm包api-messenger使用教程

    在前端开发中,我们经常需要向其他应用或者服务器发送请求并传递数据。这时候,我们需要使用一种网络通信协议。现在,发展出了许多通信协议,其中最常用的是HTTP协议。但是,纯HTTP协议不够灵活,我们需要一...

    2 年前
  • npm 包 express-fonts 使用教程

    在前端开发过程中,字体样式是重要的一部分。而 express-fonts 是一个方便快捷使用 web 字体的 npm 包。今天我们来学习一下如何使用这个包。 安装 使用 npm 进行安装,命令如下: ...

    2 年前
  • npm 包 mail-threading 使用教程

    邮件是现代社会中重要的通信工具,但是当我们需要处理大量邮件时,就会面临复杂的线程结构,这些线程结构会增加邮件处理的难度和耗时。为了解决这个问题,开发者可以利用 npm 包 mail-threading...

    2 年前
  • npm 包 obj-append-strings 使用教程

    前言 如果你是一个前端开发者,相信你一定会遇到需要对对象进行字符串的拼接的情况。在传统的开发中,我们通常会写很多繁琐的代码来实现这个功能,不仅写起来麻烦,而且还容易出现错误。

    2 年前
  • npm 包 lari-lazy-image 使用教程

    随着前端技术的不断发展,网页中的图片数量越来越多,同时也给用户带来了更好的视觉体验。但是,过多的图片也会影响页面的加载速度,导致用户等待时间过长。针对这个问题,有一种叫做懒加载(lazy load)的...

    2 年前
  • npm 包 d3-xy-zoom 使用教程

    d3-xy-zoom 是一款基于 D3.js 的可拖拽、缩放的可视化库。它可以让你在一个视觉元素上放大、平移或缩小,并且可以针对不同的坐标轴进行操作。本篇文章将为你介绍如何使用 d3-xy-zoom,...

    2 年前
  • npm 包 mod-json 使用教程

    Node.js 是一种开源的跨平台 JavaScript 运行环境,能够在服务器端运行 JavaScript 应用程序。随着 Node.js 的不断发展,npm(Node.js 包管理器)已经成为前端...

    2 年前
  • npm 包 react-native-vk-image-picker 使用教程

    随着移动互联网的普及和发展,移动端应用也越来越受到关注和重视。而对于许多开发者来说,前端技术无疑是开发移动应用的首选。在前端技术中,React Native 是一种非常流行的开发框架,它能够帮助开发者...

    2 年前
  • npm 包 childnode-remove 使用教程

    在前端开发中,我们经常需要操作 DOM 树来进行页面元素的增删改查,而原生的 JavaScript 操作 DOM 树相对来说比较繁琐,因此有很多第三方的库和工具包可以方便我们使用。

    2 年前
  • npm 包 get-test-media 使用教程

    在前端开发中,常常需要使用图片或音视频资源进行测试或展示。get-test-media 是一款可以获取多种测试媒体资源的 npm 包,方便前端开发人员快速获取测试资源。

    2 年前
  • npm 包 mobile-app-sample-java 使用教程

    前言 作为一个前端开发人员,我们经常需要开发移动端应用程序。而在开发这些应用程序时,我们需要使用一些工具来帮助我们完成任务。在这里,我们将介绍一个非常有用的 npm 包——mobile-app-sam...

    2 年前
  • NPM包set-union使用教程

    Node.js是目前最为流行的Javascript运行环境,在Node.js中使用NPM进行模块管理,NPM是Node.js的默认包管理工具,可用于安装和管理各类开源模块。

    2 年前
  • npm 包 pagination-generator-js 使用教程

    前言 在前端开发中,分页是一个非常常见的需求。如果每次都手写分页功能,不仅费时费力,而且容易出错。这时候,一个好用的分页库就能极大地提高开发效率和代码质量。pagination-generator-j...

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

    前言 随着 Web 技术的不断发展,前端开发也变得越来越复杂。很多项目的构建和管理需要借助工具进行自动化处理,而 npm 是一个非常流行的 JavaScript 包管理器,它可以方便地将前端相关的资源...

    2 年前
  • npm 包 bs-react-native-facebook-login 使用教程

    在 React Native 开发中,我们经常需要使用 Facebook 登录功能。而 bs-react-native-facebook-login 这个 npm 包提供了一个方便易用的 Facebo...

    2 年前
  • NPM包 dragon-engine 使用教程

    本文主要介绍如何使用npm包dragon-engine,包括其安装和用法。 安装 使用npm安装dragon-engine非常简单,只需要在命令行中输入以下命令即可: --- ------- ----...

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

    hkbus-cli 是一个基于 Node.js 的 npm 包,提供了香港巴士查询的命令行工具。通过该工具,用户可以快速方便地查询香港巴士的线路、站点和实时到站信息。

    2 年前
  • npm 包 ewancoder-angular-materialize 使用教程

    介绍 ewancoder-angular-materialize 是一个封装了 MaterializeCSS 组件库的 AngularJS 模块,使得在 AngularJS 中使用 Materiali...

    2 年前
  • npm 包 manalto-portal-core 使用教程

    简介 manalto-portal-core 是一个快速搭建企业级门户网站的 npm 包,提供了包括页面生成、权限管理、组织管理等功能,使用 Vue、Node.js、Element-ui 等主流技术实...

    2 年前
  • npm 包 ragmha-es6-starter-kit 使用教程

    随着前端技术的不断发展,JavaScript 作为一门主流的编程语言也不断被人们所重视。而随着 ES6 (ECMAScript 6) 的发布,JavaScript 的语法也得到了大幅度的升级和改进,使...

    2 年前

相关推荐

    暂无文章