npm包 @ekiras/markdown-it 使用教程

简介

@ekiras/markdown-it 是一个用于 Node.js 和浏览器的 Markdown 解析器。该包基于markdown-ithighlight.js开发而成,具有很多定制的选项和插件。在前端开发中,我们常常需要将 markdown 文本解析成标准的 HTML 页面,@ekiras/markdown-it 可以完美地胜任这项工作。

安装

我们可以使用 npm 命令来安装该包:

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

其中,@ekiras/markdown-it 是我们要安装的包名,highlight.js 是该包所依赖的另一个包。

使用

以下是一个简单的示例:

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

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

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

解析后会输出以下结果:

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

通过运行以上示例,我们可以看出 @ekiras/markdown-it 的主要用途是将 markdown 文本转换为 HTML 标记。

语法

@ekiras/markdown-it 提供了完整的 markdown 语法支持,包括:

标题

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

粗体和斜体

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

分割线

---

引用

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

列表

无序列表:

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

有序列表:

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

代码块

inline code:

---- - - --

代码块:

--- ----------
--- - - --
---------------
--- --
Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
---- -------- --------------- -------- -----

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

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

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

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

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

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

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

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

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

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

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

--------

--------

---

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

---

--- -----

----------

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

--------

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

--- ----

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

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

--- -----

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

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

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

输出结果:

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

总结

@ekiras/markdown-it 提供了非常强大的 markdown 转换功能,可以帮助前端工程师处理 markdown 文本,并将其解析为标准的 HTML 标记。在实际应用中,我们可以根据需要进行定制,以便更好地满足业务需求。同时,@ekiras/markdown-it 还为我们提供了丰富的 API,可以更好地支持扩展和二次开发,我们有必要深入研究其原理并加以应用。

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


猜你喜欢

  • npm 包 wmts-to-mbtiles 使用教程

    1. 什么是 wmts-to-mbtiles wmts-to-mbtiles 是一个基于 Node.js 开发的 npm 包,它可以将 WMTS 数据转换为 mbtiles 格式,并可用于在地图上显示...

    3 年前
  • npm 包 anomaly-finder 使用教程

    anomaly-finder 是一个能够自动检测异常数据点的 npm 包。它使用 Twitter 开源的 AnomalyDetection 算法来检测数据中的异常点,并返回一个异常点的数组,可以用于数...

    3 年前
  • npm 包 babel-preset-lusk 使用教程

    在前端开发中,使用 ECMAScript 6 (ES6) 语法编写代码已经是一个不可避免的趋势。然而,由于浏览器的兼容性问题, ES6 代码需要通过转换工具转成 ES5 代码,以便在浏览器中运行。

    3 年前
  • npm 包 laxar-angular-adapter 使用教程

    前言 laxar-angular-adapter 是一个用于集成 LaxarJS 和 AngularJS 的 npm 包。通过使用这个包,您可以让 AngularJS 嵌入到 LaxarJS 中,从而...

    3 年前
  • npm包babel-plugin-sitrep使用教程

    简介 babel-plugin-sitrep是一个用于检测JavaScript文件中函数调用次数的Babel插件。它将在控制台打印出函数调用情况的详细信息,包括函数的名称、调用次数、参数等,并将信息记...

    3 年前
  • npm 包 front-matter-pug 使用教程

    前端开发中,我们经常需要使用一些工具和框架来辅助我们完成日常工作。例如,我们可能需要使用一些插件来处理页面中的元数据,或者我们需要使用一些工具来编译和打包我们的代码。

    3 年前
  • npm包postcss-focus-ring使用教程

    前言 在设计网站和应用程序时,键盘焦点效果可以使用户能够更容易地识别他们所交互的元素。但是,浏览器默认的键盘焦点效果并不总是令人愉快或一致。这就是为什么开发人员可以使用postcss-focus-ri...

    3 年前
  • npm包webpack-macro-loader 使用教程

    npm是目前前端开发中非常流行的一个包管理工具,通过npm可以轻松地下载、安装、使用各种前端开发工具。webpack-macro-loader是一个非常有用的npm包,在Webpack构建工具中使用它...

    3 年前
  • npm 包 eslint-config-rsupport 使用教程

    ESLint 是一款常用的 JavaScript 代码检查工具,它可以帮助开发者发现代码中的一些潜在问题,提高代码质量和可读性。而 eslint-config-rsupport 是一款针对智慧社区应用...

    3 年前
  • npm 包 @easyapi/easyapi 使用教程

    简介 在现代的前端开发中,构建和管理 API 是一个必不可少的环节。@easyapi/easyapi 是一个 npm 包,它提供了一个简洁的方法来构建 REST API。

    3 年前
  • npm 包 dynatable 使用教程

    在 Web 前端开发过程中,我们经常需要在表格中展示大量的数据,而且需要给用户提供各种不同的操作和筛选功能。为了避免重复造轮子,我们可以使用现有的 npm 包 dynatable,它可以让我们快速构建...

    3 年前
  • npm 包 animated-vue 使用教程

    在开发 Vue 应用程序时,我们经常需要使用动画效果来增强用户体验,animated-vue 是一个 Vue 插件,提供了一种简单的方法来添加动画到 Vue 组件中。

    3 年前
  • npm 包 @p2/grid 使用教程

    简介 @p2/grid 是一个开源的前端网格系统,它专门用于处理网页中各种布局与定位需求。使用本系统,您可以便捷地实现网页的栅格系统布局,适用于多种场景,例如响应式设计、单页面 Web 应用、桌面应用...

    3 年前
  • npm 包 create-observable-thunk 使用教程

    介绍 create-observable-thunk 是一个用于创建动作(Action)和异步操作(Thunk)的小型库,它是基于 Redux 和 RxJS 技术栈构建的。

    3 年前
  • npm 包 @blank-string/static.blankstring.surge.sh 使用教程

    介绍 @blank-string/static.blankstring.surge.sh 是一款基于 npm 包管理工具的前端工具,可以帮助你快速搭建一个静态网站并且部署到 Surge.sh 上,它具...

    3 年前
  • npm 包 cordova-plugin-wininsoft-file-opener2 使用教程

    在移动开发中,我们经常需要让用户浏览一些文件,如 PDF、Word、Excel 等。而在 Cordova 中,我们可以使用 cordova-plugin-wininsoft-file-opener2 ...

    3 年前
  • npm 包 @blank-string/media.blankstring 使用教程

    在前端开发的过程中,我们常常需要使用各种各样的框架、库和工具。而 npm 包则是这其中不可或缺的一环。而本文将详细的讲解一个 npm 包的使用教程,它就是 @blank-string/media.bl...

    3 年前
  • npm 包 webpack-bugsnag-plugin 使用教程

    前言 在前端开发中,我们经常使用 webpack 来打包和构建我们的代码。而 webpack-bugsnag-plugin 是一个专门为 webpack 设计的插件,可以实现错误捕获并上报至 Bugs...

    3 年前
  • npm 包 @bodetree/react-smooth-collapse 使用教程

    什么是 @bodetree/react-smooth-collapse? @bodetree/react-smooth-collapse 是一个 React 组件,它可以帮助我们实现基于动画效果来展开...

    3 年前
  • npm 包 @bodetree/react-toolbox 使用教程

    在前端开发中,使用已有的第三方库、工具可以提高我们的开发效率,降低开发成本。而 npm 是当前前端开发中最广泛使用的包管理器,拥有数以万计的开源的 JavaScript 包可以供我们使用。

    3 年前

相关推荐

    暂无文章