npm 包 mandre 使用教程

阅读时长 3 分钟读完

什么是 mandre

mandre 是一个 Node.js 编写的命令行工具,用于将 Markdown 文档转换为 HTML 页面。它具有以下特点:

  • 支持代码高亮
  • 支持使用 CSS 样式进行页面美化
  • 支持多种语言代码块的渲染
  • 支持自定义页头页尾
  • 支持生成目录

下面,我们来一步步学习如何使用 mandre。

安装 mandre

mandre 基于 Node.js 编写,因此需要先安装 Node.js。安装好 Node.js 之后,通过以下命令可以全局安装 mandre:

使用 mandre

mandre 可以将源文件夹中的所有 Markdown 文件转换为 HTML 页面。使用 mandre 的命令格式如下:

source-dir 表示存放 Markdown 文件的源文件夹路径,output-dir 表示转换后 HTML 文件存放的目标文件夹路径。options 是可选的,我们下面会详细介绍一些常用的 options。

例如,我们有如下的 Markdown 文件:

我们可以使用以下命令将 docs 文件夹下的所有 Markdown 文件转换为 HTML 页面:

其中,docs_html 是输出的 HTML 文件存放的目录。转换后的 HTML 文件保留原始文件的目录结构。

生成目录

如果想要生成目录,可以在命令中加上 --toc 参数。例如:

这样,转换后的 HTML 页面会带有目录。

自定义页头页尾

如果想要自定义页头页尾,可以在命令中加上 --header 和 --footer 参数。例如:

这样,header.html 和 footer.html 分别作为页头和页尾插入到每个 HTML 页面中。

代码高亮

mandre 使用 highlight.js 标记代码,因此支持多种语言的代码高亮。如果想要高亮代码,需要安装 highlight.js:

然后,在命令中加上 --highlight 参数,例如:

使用 CSS

mandre 支持使用 CSS 样式进行页面美化。如果想要使用 CSS,需要将 CSS 文件放在源文件夹根目录下,并在命令中加上 --css 参数。例如:

这样,style.css 文件就会被引入到转换后的 HTML 页面中。

总结

通过本文,我们学习了如何使用 mandre 进行 Markdown 转 HTML,包括安装和使用方法,以及一些常用的选项。希望能够帮助大家更好地使用 mandre 进行文档转换。下面是一些示例代码:

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005569081e8991b448d3584

纠错
反馈