Skip to content

md2html 快速上手

使用md2html CLI

TIP

推荐 Node.js 版本高于v16.0

使用你喜爱的包管理器安装 @md2html/cli全局

bash
npm install @md2html/cli -g
bash
pnpm install @md2html/cli -g
bash
yarn global add @md2html/cli

安装完成后即可使用 mth 命令来转换。


下面是一些简单的使用示例:

bash
mth docs.md

将当前目录的docs.md文件转换为html

bash
mth docs.md -o output/

将当前目录的docs.md文件转换至/output/index.html

bash
mth docs.md -w

监听模式,开启服务器,实时监听markdown文件更新并转换。

更多参数可以使用mth -h来查看,或参考参数与配置

我们提供了一个带有配置文件的示例项目,见example

Released under the MIT License.