新的Markdown CLI

新的Markdown编写方式

NMD代表 新的Markdown，或者对朋友们来说，Nicola Markdown（如果Stephen Bourne可以为shell命名，我为什么不能为我自己的命名NMD？）

入门指南

你想轻松快速地将Markdown迁移到新的Markdown吗？请阅读如何使用CLI实现！

TL;DR

cargo install nmd

nmd generate dossier -p dossier/input/path -f -w

nmd dossier -p dossier/input/path add -d new-document.nmd

nmd build -i input/path

安装

您可以使用Cargo或从GitHub下载最新版本来安装NMD。

cargo install nmd

NMD CLI

生成新的文件夹

要 生成新的文件夹，可以使用以下命令

nmd generate dossier -p dossier/input/path

您可以在 generate dossier 的组合中使用许多 标志。例如，如果您想 强制 生成，可以使用 -f，或者如果您想添加一个 欢迎页面，可以使用 -w。

nmd generate dossier -p dossier/input/path -f -w

Git支持计划中，但尚未实现。您只能使用 .gitkeep 文件在 -k 中添加到资产目录。

-n 允许指定文件夹名称。

Markdown到新Markdown

您可以使用 --from-md <md-file-path> 选项轻松地将标准Markdown文件转换为新的Markdown文件夹。

添加新文档

要 添加新文档，可以使用以下命令

nmd dossier -p dossier/input/path add -d new-document.nmd

如果文档名称没有 nmd 扩展名，它将自动添加。

您可以同时添加多个文档。

nmd dossier -p dossier/input/path add -d new-document-1.nmd -d new-document-2.nmd -d new-document-3.nmd

重置文件夹配置

nmd dossier -p dossier/input/path reset [ -p ]

-p 重置标志以保留文档列表。

构建

您可以通过 build 命令构建文件夹或单个文件。

唯一必需的选项是输入路径。它可以是目录（文件夹）或文件的路径。

nmd build -i input/path

compile 命令有很多选项。您可以使用 -f <format>（例如 html，默认格式），通过 -o <output-path> 指定输出路径，或者使用 -t <theme> 指定主题。可用的主题有

• 浅色
• 深色
• 复古
• 科学
• 无

nmd compile -f html dossier -i dossier/input/path -o artifact/output/path

此外，如果您要监视文档夹文件并在有更改时编译它们，应使用监视模式（-w 选项）。监视模式在检测到任何更改时编译文档夹。只有当经过最小时间后，才会捕获更改。要设置最小时间，请使用 --watcher-time 选项。

--fast-draft 用于创建文档夹的快速草稿，通常编译器生成它所需的时间更少。

--parallelization 用于并行化工作（默认为单线程）。

-s <document1> -s <documentN> 用于仅编译文档夹配置列表中的部分文档。

最后，如果您正在使用 NMD 编写并希望预览，可以使用 -p 选项进行编译。 -p 在 127.0.0.1:1234（通过 --preview-scraping-interval <interval> 以毫秒为单位设置客户端抓取间隔）上的 Web 服务器上呈现预览。

nmd analyze -i input/path