文档概要

kc-cli 能为你做什么?

kc-cli 作用的文件类型:目前只支持.md后缀的文件类型。下面是 kc-cli 能为你做的:

  • 批量创建SUMMARY.md里的.md文件(已经存在的会跳过)。
  • 批量把文档项目下所有的.md文件添加到目录文件SUAMMARY.md(不会覆盖原SUAMMARY.md,会生成一个叫"_summary.md"的文件)。
  • 初始化文档配置(样式自定义、插件、.gitignore、封面、文档概要等),如果你已经做了配置,kc-cli 会跳过。
  • 导出为 Docx、HTML文件(这部分功能依赖pandoc进行,kc-cli 进行了简化处理,如果有特殊需求自己看pandoc的文档,自行转换)。需要说明的是:这部分的输出不会携带看云的版权标识,自然的这部分输出也不会影响到看云,因为这是本地操作,不会反馈到看云。导出的文件统一存放在./KCout/ 下(已经通过.gitignore 文件排除,不会随 git 推送到看云,不过保险起见推送之前还是先自己确认下!!!)。

>使用 pandoc 进行文件转换往往会发生很多鬼畜的事情,转换效果可能也在你的意料之外。这也不怪 pandoc ,因为 Markdown 本身就有很多衍生语法,完美兼容不太容易。