npm 包 mdp02 使用教程

阅读时长 3 分钟读完

介绍

mdp02 是一个用于生成 Markdown 文件的 npm 包。它支持生成多种样式的 Markdown 文档,包括简洁的风格和漂亮的样式排版。本文将介绍 mdp02 的安装和使用。

安装

在使用 mdp02 之前,需要确保已经安装了 Node.js 和 npm。在终端中运行以下命令进行安装:

用法

mdp02 支持多种参数,以便你可以自定义输出的 Markdown 文件的样式和内容。以下是常用的参数:

  • --input: 指定输入文件或文件夹的路径。
  • --output: 指定输出 Markdown 文件的路径。
  • --style: 指定 Markdown 文件的样式。
  • --toc: 添加目录,目录将按照文件的层级结构生成。
  • --title: 指定文件的标题。

例如,以下命令会将输入文件夹中的所有 Markdown 文件转换为 HTML 文件,并按照指定的样式排版:

如果要生成带目录的文件,可以运行以下命令:

示例代码

下面是一个示例 Markdown 文件:

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

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

-- --

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

-- --

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

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

-- ---

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

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

链接和图片

Markdown 支持链接和图片的表示方式。

  • 链接使用 [] 和 () 进行表示
  • 图片使用 ![] 和 () 进行表示

我是一个链接

mdp02 --input=./test.md --style=style.css --output=./html --title="Markdown 示例"

纠错
反馈