简介
md2ghp 是一个 Node.js 的模块，用于将 Markdown 文件转换为 GitHub Pages 可以直接展示的 HTML 页面。其支持多种主题、语法高亮、TOC 等特性，使得你能够更加便捷地将自己的文章发布到 GitHub Pages 上。
安装
使用 npm 安装 md2ghp：
npm install -g md2ghp
使用
命令行使用
- 进入你的 Markdown 文件所在的目录，执行下面的命令：
md2ghp -i <input.md> -o <output.html>
其中，<input.md> 为你的 Markdown 文件名，<output.html> 为转换后的 HTML 文件名。
- 您可以添加以下选项来自定义您的输出：
| 选项 | 类型 | 描述 |
|---|---|---|
-t, --theme <theme> |
string |
设置主题名称，默认为 default。 |
-c, --css <css> |
string |
设置自定义 CSS 文件路径。 |
-p, --port <port> |
number |
设置本地服务器端口号，默认为 8080。 |
-T, --notoc |
boolean |
禁用自动生成 TOC。 |
-h, --help |
- | 显示命令帮助信息。 |
例如，以下命令将在本地启动一个服务器，并将 test.md 转换为 test.html，使用 light 主题和自定义样式 custom-style.css：
md2ghp -i test.md -o test.html -t light -c custom-style.css -p 80
在代码中使用
md2ghp 可以通过 JavaScript API 在代码中使用。以下是一个例子：
-- -------------------- ---- ------- ----- ------ - ------------------ -------------------------------- - ------ ---------- ---- ----- ---- ----------------------- -- ----- ----- -- - ------------------ ---
总结
md2ghp 是一个简单易用的将 Markdown 文件转为 GitHub Pages 的工具。通过本教程，您已经了解了如何使用它。当您需要将自己的文章发布到 GitHub Pages 上时，md2ghp 提供了一种快速便捷的方式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600567f781e8991b448e41c9