npm 包 gulp-markdown 使用教程

介绍

gulp-markdown 是一个基于 Gulp 的 Markdown 编译工具，可将 Markdown 文件转换为 HTML 或其他格式。它支持多种配置选项，包括标准的 Markdown 语法、扩展语法、代码高亮等。

安装

使用 npm 进行安装：

npm install gulp-markdown --save-dev

使用方式

在 gulpfile.js 中引入 gulp-markdown，然后定义任务：

const gulp = require('gulp');
const markdown = require('gulp-markdown');

gulp.task('markdown', function() {
  return gulp.src('./src/*.md')
    .pipe(markdown())
    .pipe(gulp.dest('./dist'));
});

上面的代码将会把 src 目录下所有的 Markdown 文件编译成相应的 HTML 文件，并输出到 dist 目录。

配置选项

gulp-markdown 提供了丰富的配置选项，可以通过传递一个对象参数进行设置。以下是一些常用的选项：

gfm

类型：Boolean 默认值：true

启用 GitHub Flavored Markdown 扩展语法。

.pipe(markdown({gfm: false}))

tables

类型：Boolean 默认值：true

启用表格语法。

.pipe(markdown({tables: false}))

breaks

类型：Boolean 默认值：false

启用回车换行语法。

.pipe(markdown({breaks: true}))

smartLists

类型：Boolean 默认值：true

启用智能列表语法。

.pipe(markdown({smartLists: false}))

smartypants

类型：Boolean 默认值：false

启用 SmartyPants 扩展语法。

.pipe(markdown({smartypants: true}))

highlight

类型：Function(code, lang) 默认值：null

使用指定的代码高亮库对代码进行高亮。需要提供一个回调函数，参数为代码和语言类型，返回值为高亮后的 HTML 代码。

以下是一个使用 highlight.js 库进行高亮的示例：

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

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

总结

通过使用 gulp-markdown，我们可以很方便地将 Markdown 文件转换为 HTML 或其他格式，并且可以根据需要进行灵活配置，满足不同的需求。希望这篇文章能够对你了解和使用 gulp-markdown 有所帮助。

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