在前端开发中,经常需要将 Markdown 文件转换为 PDF 格式以便于分享和打印。gulp-markdown-pdf
是一个 Node.js 模块,提供了方便的方式来实现这一目标。
安装
首先,需要安装 gulp
和 gulp-markdown-pdf
:
npm install -g gulp npm install --save-dev gulp-markdown-pdf
配置
在项目根目录下创建一个名为 gulpfile.js
的文件,并添加以下内容:
const gulp = require('gulp'); const markdownpdf = require('gulp-markdown-pdf'); gulp.task('default', function () { return gulp.src('src/**/*.md') .pipe(markdownpdf()) .pipe(gulp.dest('dist')); });
上述代码中,gulp.src()
指定源文件路径,markdownpdf()
转换 Markdown 文件为 PDF 格式,gulp.dest()
指定输出路径。
使用
执行以下命令即可将 src
目录下所有 Markdown 文件转换为 PDF 并输出到 dist
目录下。
gulp
你也可以只转换单个文件:
gulp src/sample.md
如果需要自定义样式,可以通过传递选项参数来实现,例如:
-- -------------------- ---- ------- ------------------------- -------- -- - ----- ------- - - -------- --------------------- ------------ ----- ----------------- ----------- -- ------ ----------------------- --------------------------- ------------------------- ---
上述代码中,cssPath
指定自定义 CSS 文件路径, paperFormat
和 paperOrientation
分别指定纸张格式和方向。
总结
使用 gulp-markdown-pdf
可以轻松地将 Markdown 文件转换为 PDF 格式,并提供了一些自定义选项来满足个性化需求。希望这篇文章对你有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/41165