npm 包 markdown-it 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

markdown-it 是一个流行的 Markdown 解析器，它具有扩展性和灵活性，可以通过插件来实现各种不同的功能。在前端开发中，markdown-it 可以用于将 Markdown 文本转换为 HTML 代码。

本文将介绍如何使用 npm 包 markdown-it，让你快速上手并实现自己的需求。

安装

使用 npm 安装 markdown-it：

npm install markdown-it --save

安装完成后，在项目中引入 markdown-it：

const MarkdownIt = require('markdown-it');
const md = new MarkdownIt();

基础用法

将 Markdown 文本转换为 HTML：

const result = md.render('# Hello markdown-it!');
console.log(result); // <h1>Hello markdown-it!</h1>

配置选项

可以通过传递配置对象来创建一个新的 markdown-it 实例，并覆盖默认选项。下面是一些常见的配置选项：

html

启用原生 HTML 标签的解析，默认为 false。

const md = new MarkdownIt({html: true});
const result = md.render('<div>Hello World</div>');
console.log(result); // <div>Hello World</div>

linkify

自动将 URL 和 Email 转换为链接，默认为 false。

const md = new MarkdownIt({linkify: true});
const result = md.render('http://example.com');
console.log(result); // <a href="http://example.com">http://example.com</a>

typographer

启用智能标点符号替换，例如将引号转换为左右引号，默认为 false。

const md = new MarkdownIt({typographer: true});
const result = md.render('"Hello, World!"');
console.log(result); // “Hello, World!”

插件

markdown-it 支持各种插件，可以通过它们来扩展 markdown-it 的功能。下面是一些常见的插件：

emoji

将 Emoji 转换为 HTML 实体。

安装：

npm install markdown-it-emoji --save

使用：

const MarkdownIt = require('markdown-it');
const emoji = require('markdown-it-emoji');
const md = new MarkdownIt().use(emoji);

const result = md.render(':smile:');
console.log(result); // <p>😄</p>

highlight.js

使用 highlight.js 来高亮代码块。

安装：

npm install highlight.js --save

使用：

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

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

----- ------ - --------------------------------------------- -----------------
-------------------- -- ---- ------------------------ --------------------------------------------- --------------------------- ----------------展开代码

总结

本文介绍了如何使用 markdown-it 来将 Markdown 文本转换为 HTML 代码，并且介绍了一些常见的配置选项和插件。希望能够对你有所帮助！

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/32931

npm 包 markdown-it 使用教程

简介

安装