npm 包 markdown-pdf 使用教程

阅读时长 3 分钟读完

简介

markdown-pdf 是一个 Node.js 应用程序,可以将 Markdown 文件转换为 PDF 文件。 它与许多其他 Markdown 转换器不同的是,它支持 CSS 样式表和页眉页脚等高级特性。 这使得 markdown-pdf 成为一个非常有用的工具,尤其是对于那些需要在项目中生成文档的前端开发人员来说。

安装

使用 npm 来安装 markdown-pdf:

该命令会将 markdown-pdf 安装到全局环境中,以便您可以在终端中访问它。

使用

基本使用

要将 Markdown 文件转换为 PDF 文件,请打开终端并运行以下命令:

其中,input.md 是要转换的 Markdown 文件的路径,output.pdf 是要保存 PDF 文件的路径。

自定义样式

默认情况下,markdown-pdf 会使用内置样式创建 PDF 文件。 如果您想自定义样式,可以使用 --css 选项指定 CSS 文件的路径。 例如:

自定义页眉和页脚

要添加自定义页眉和页脚,请创建一个包含 HTML 的文件,并使用 --header 或 --footer 选项指定其路径。 例如:

其中,header.html 和 footer.html 是包含 HTML 的文件的路径。

其他选项

除了上述选项之外,markdown-pdf 还提供了许多其他选项,例如:

  • --highlight-style:指定代码高亮样式。
  • --paper-format:指定纸张格式(如 A4、Letter 等)。
  • --paper-orientation:指定纸张方向(如横向或纵向)。

您可以使用 markdown-pdf --help 命令查看所有可用选项。

示例代码

以下是一个示例 Markdown 文件,它将转换为 PDF 文件并应用自定义样式和页眉页脚:

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

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

-- ------- -

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

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

-- ------- -

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

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

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

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

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

markdown-pdf example.md -o example.pdf --css custom.css --header header.html --footer footer.html

纠错
反馈