mdo 是一个小型的命令行工具，它可以快速创建一个 Markdown 文件，并自动注入一些基本的文档信息，如 title、description、author 等等。这是一个非常方便的工具，尤其是对于那些需要频繁创建文档的前端开发者而言。
在本篇文章中，我们将一步步地讲解如何使用 mdo 工具，并提供一些示例代码，以帮助读者快速上手。
安装
首先，我们需要全局安装 mdo 工具。打开终端并输入以下命令：
npm install -g mdo
如果一切正常，安装完成后我们就可以开始使用了。
基本使用方法
创建新的 Markdown 文件
要创建一个新的 Markdown 文件，我们只需要在终端中输入以下命令：
mdo new filename.md
其中 filename.md 是你要创建的文件的名字。执行上述命令会自动在当前目录下创建一个名为 filename.md 的文件，并自动注入一些基本信息。
编辑 Markdown 文件
要编辑已经存在的 Markdown 文件，我们只需要在终端中输入以下命令：
mdo edit filename.md
执行上述命令会自动打开 filename.md 文件，可以使用你最喜欢的文本编辑器来编辑它。
查看 Markdown 文件信息
要查看一个 Markdown 文件的基本信息，我们只需要在终端中输入以下命令：
mdo info filename.md
执行上述命令会自动打印出 filename.md 文件的基本信息，如 title、description、author 等等。
基本信息设置
mdo 支持在 Markdown 文件中设置一些基本信息。这些信息将在 info 命令中显示，并且在一些 Markdown 主题中可能会用到。以下是一些基本信息的示例：
-- -------------------- ---- ------- --- ------ -- -------- ------------ ---- -- - ---- --------- ------- ---- --- --- - -- -------- ---- -- - ---- ---------
在上面的示例中，三条破折号之间的内容是基本信息的设置，title、description 和 author 是其中的三个属性。
命令行参数
下面是一些 mdo 工具支持的命令行参数：
-p, --path <path> 设置生成文件的所在路径 -t, --template <template> 设置使用的模板 -v, --version 查看版本信息 -h, --help 查看帮助信息
-p, --path：可以使用此参数指定生成的文件所在的路径。例如，如果你想在一个名为docs/的文件夹中生成 Markdown 文件，可以执行以下命令：mdo new hello.md --path docs/
上述命令会在
docs/文件夹中生成一个名为hello.md的文件。-t, --template：可以使用此参数指定要使用的模板。mdo工具默认提供了两个模板：default和docsify。如果你要使用docsify模板生成 Markdown 文件，可以执行以下命令：mdo new hello.md --template docsify
上述命令会使用
docsify模板生成一个名为hello.md的文件。-v, --version：可以使用此参数查看mdo工具的版本信息。-h, --help：可以使用此参数查看mdo工具的帮助信息。
使用示例
以下是一个示例，演示如何使用 mdo 工具创建一个新的 Markdown 文件，并添加自定义的信息。
首先，我们在终端中执行以下命令：
mdo new mydocument.md
然后，我们在 mydocument.md 文件中添加自定义的信息，并编写一些内容，如下所示：
-- -------------------- ---- ------- --- ------ -- -------- ------------ ---- -- - ---- --------- ------- ---- --- ----------- ---------- ----------- ---------- ----- ------ --------- --------- --- - -- -------- ---- -- - ---- --------- -- ------------ ----- ----- ----- --- ----- ----------- ---------- ----- --------- ---------- ------ --- -------- ---------- --- ------ --------- --- --- -------- ----- ----- ---- ------- -------- ------- -- ---- ---- -------- --- ----------- ---- ------- -- ---------- ------------ -------- ----- --------- -------- -- ----- -- --------- ----- -- ------ -------- --- --- ---- --- ------ ------- --------- --- --- ------- ----- ------- ------ ----- -- ---- ------ ---------- ------ ---- ----- ------- --- ---- -------- ----- ----------- -- ----
最后，我们运行以下命令以查看 mydocument.md 文件的基本信息：
mdo info mydocument.md
输出结果应该是这样的：
title: My Document description: This is a test document. author: John Doe created_at: 2020-01-01 updated_at: 2021-01-01 tags: [test, document, markdown]
到此为止，我们已经了解了如何使用 mdo 工具来创建和编辑 Markdown 文件，并添加自定义的信息。希望这篇文章可以帮助读者更好地使用这个小工具，提高工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005587681e8991b448d5b51