Home

也许我们需要一个配置文件来设置如何更新目录、如何批量创建文件、哪些文件是不用处理的，哪些是需要时刻监视。好处在于我们不必在每次处理时都去处理命令参数（搞砸了就麻烦了）。 命令 | 描述 -----|----- `help` | helper。 `config` | 定义配置文件，（会在当前文件夹下创建" summaryConf.json "文件，如果觉得它多余请在 push 之前将其删除或者添加到 '.gitignore' 中），*建议添加到".gitignore"中而不是删除，以后可能还会用到。*` `update` | 更新目录，（会在当前文件夹下创建" _summary.md "文件，如果觉得它多余请在 push 之前将其删除或者添加到 '.gitignore' 中）. `create` | 创建已经列入目录但还未被创建的文件(只是写了大纲，没写文件的文件)。*已经存在的文件以及远程文件都会被忽略，不会创建*。 `watch` | 监视项目文件夹下的所有文件（除了被排除的文件），每当文件有更改时，及时作出处理——相当于自动执行` --update ` 命令。

将 `SUMMARY.md` 中列出的文件批量创建到当前项目文件夹（已存在的文件将忽略）。

index.js

创建` _summary.md `(默认) 文件，将未被加入到` SUMMARY.md `的文件列入其中，简单地说是批量生成链接。**已存在于 `SUMMARY.md` 的文件将不会再列出**。 注意： - 使用 Git 等工具提交时应注意 `_summary.md` 是否应该随文档一起提交。它只是个临时文件，应该在执行提交之前删掉它或者将其添加到类似 `.gitignore` 中默认排除在项目文件之外。 - 相应地，如果有配置文件（使用 `zz config` 命令时创建的配置文件）：`summarymd.json` , 它是临时目录更新、批量创建文件的任务配置文件。若是团队协作，则应该保留并提交（如果成员都用 summarymd 包的话——使用相同的配置可以保证处理方式的一致性）。 反之，则应该在提交之前删除或者添加到类似 `.gitignore` 中，避免混入项目文件中。