代码拉取完成，页面将自动刷新
当cli 工具使用时，首次执行会报错（因为没有 summaryConfig.js 文件，此时会创建，再次运行即可）。 如果启用了监视，期间如果更改了配置文件，需要结束监视（ctrl+C）后再次开启监视方能生效。
V2.0.0+是一个全新的版本，以前的接口不再支持！！！
之前不怎么用 Gitbook ，后来发现 summarymd 实现的功能类似 Gitbook 的 “gitbook init” 命令。
summarymd 可以：
YAML 头并不能被准确解析（本模块依赖 markdown-it 解析 markdown ）。这会影响生成临时目录的准确性。除非你在 YAML 头之后增加一个能解析为
<h1>...<h1>的 markdown 标记。
使用缩进是为了便于理清文档先后顺序——对于那些没有列入 summary 清单文件的文档，在列入之前你需要手动调整文档顺序，然后手动追加到真正的 summary 文件（比如
summary.md）中。（这个包生成的 summary 列表只是个临时的 markdown 文件，默认文件名："_summary.md"）。
SUMMARY.md中列表存在的问题：
SUMMARY.md 没有修正或者创建这个文件。[](doc/example.md)
这个设计只在命令行中有体现：
summarymd status或者summarymd -s，如果要在项目模块中使用，可通过._summaryStatus_hasProblems().problem_with_URL和._summaryStatus_hasProblems().problem_with_Text获取对应的返回值。
安装到项目：
npm i summarymd
全局安装：
npm i -g summarymd
全局安装之后运行
summarymd -h来获取命令行支持的功能以及用法。
const summarymd = require('summarymd')
const sm = new summarymd() // must use with new
// change configs
// 在创建文件时用文件名作为文档一级标题。
sm.configs.confs_with_create.isUseFileBasenameAsTitle = true;
// 用“+”作为列表标记。
sm.configs.confs_with_summary.listSing ='+';
//...... 你可以更改更多的配置项来创建文件或生成临时目录
// 根据 summary 文件创建 markdown 文件。
sm.create((t)=>{return `# ${t}\n[TOC]`})
/* 文件创建之后的内容类似:
# example
[TOC]
*/
sm.update() // 生成临时目录。
配置项较多，单纯使用命令参数来处理会比较麻烦，我们通过配置文件来处理如何创建文件以及如何更新临时目录。
首先，创建配置文件到项目工作路径下(summaryConfig.js)：
summarymd init
如果要重置配置文件，执行
summarymd reinit。
接着，根据自己的需要更改配置文件并保存，比如设置缩进、列表标记、文档模板函数等。
完成前面两步，现在可以用命令工作了：
summarymd create
用 create 创建文件。
summarymd update
用 update 更新临时目录。
summary watch
用 watch 自动监视文件变化，自动执行
summarymd create和summarymd update操作。
源码：
this.configs = {
// 要处理的文件（路径要补全，即使"./SUMMARY.md" 和 "SUMMARY.md" 等效，但必须写成"./SUMMARY.md"）
includes: ['./**/*.md', './**/*.markdown'],
// 正式的目录文件路径（路径要补全，即使"./SUMMARY.md" 和 "SUMMARY.md" 等效，但必须写成"./SUMMARY.md"）
summary: "./SUMMARY.md",
// 创建文件的配置
confs_with_create: {
/**
* 在创建文件时是否跳过URL为空或者链接文本为空的列表。
*/
isSkipEmptyTitleOrEmptyPath:true,
// 远程路径匹配表达式(无法创建远程文件，如果可以你可以尝试下载它们，但这里只能将其排除)
remoteURLregexp: /(\w\:\/|(\.\.\/)|(\:\\\\)|(\w+\:\d+)|\~\/|(\d.+\.\d).[\/|\:\?]?)|((\w\.[\w|\d]).*\/.+([\/]|\:\d|\.html|\.php|\.jsp|\.asp|\.py))/g,
},
// 更新临时目录的配置
confs_with_summary: {
// 临时目录文件路径（路径要补全，即使"./SUMMARY.md" 和 "SUMMARY.md" 等效，但必须写成"./SUMMARY.md"）
tempSummary: "./_summary.md",
// 是否用文件名作为目录列表的链接的文本。
isUseBFasLinkText: false,
// 列表标记符号
listSing: "+",
// 是否对链接进行编码
isEncodeURI: false,
// 目录列表缩进的配置
indent: {
// 是否使用缩进。
isIndent: true,
// 缩进长度
indentLength: 4,
// 按 路径|标题 缩进
/**
*
* 必须是这样的格式（IndentByDirs 和 IndentByTitle 都是）：
* @example
*
* [ { basis:/\/js\//, times:1 }, ...]
*
* basis: 缩进规则，最好是正则表达式，因为代码中都是用 basis.test() 方法来测试是否匹配缩进规则的。
* times: 缩进次数，必须是数值，最终的缩进量 = indentLength * times
*
* 注意:
*
* 不能同时定义 IndentByDirs 和 IndentByTitle 。定义了一个，另一个则应该为 null。
*/
IndentByDirs: null,
/** @see IndentByDirs*/
IndentByTitle: null,
}
}
};
// 要排除的文件。
this.excludes = ['!./node_modules/**/*.*','!'+this.configs.summary,'!'+this.configs.confs_with_summary.tempSummary]
配置文件通过 ：summarymd init 生成。生成的文件为：./summaryConfig.js 。它的内容如下：
// you can add more property if you need(Different from defaults). but don't del the default propertys(you can change the value).
// Why not JSON? For the summarymd module, you can redefine anything and use JavaScript files to customize configuration files with greater freedom.
// If you need more customization, consider using the summarymd module instead of the command line.
const confs ={
//
// it's just a default string ,you can do more. the "%title%" will be replaced by true title.
template: "# %title%",
// 要包含的文件描述。
includes: ['./**/*.md', './**/*.markdown'],
// 要排除的文件描述。
excludes:['!./node_modules/**/*.*'],
// 正式目录文件。
summary: "./SUMMARY.md",
confs_with_create: {
/**
* 在创建文件时是否跳过URL为空或者链接文本为空的列表。
*/
isSkipEmptyTitleOrEmptyPath:true,
// 远程路径匹配规则。
remoteURLregexp: /(\w\:\/|(\.\.\/)|(\:\\\\)|(\w+\:\d+)|\~\/|(\d.+\.\d).[\/|\:\?]?)|((\w\.[\w|\d]).*\/.+([\/]|\:\d|\.html|\.php|\.jsp|\.asp|\.py))/g,
},
confs_with_summary: {
// 临时目录文件。
tempSummary: "./_summary.md",
// 是否使用基础文件名作为链接文本。
isUseBFasLinkText: false,
// Markdown 列表标记符。
listSing: "*",
// 是否对链接进行 URL 编码。
isEncodeURI: false,
indent: {
// 是否进行缩进, 'false'的话，后续的缩进设置会被忽略，不会执行缩进。
isIndent: true,
// 单次缩进的空格个数。 本模块的实际缩进量 = indentLength * times，照目前的配置，缩进2次就是缩进 8 个空格。
indentLength: 4,
/* 下面两个配置项控制自定义缩进规则，基本格式为：
[{basis:/npm/g,times:1}]
basis -缩进规则，类型：正则表达式
times -缩进次数（注意：不是缩进量是缩进次数）
上面例子表示： 匹配到 "npm" 就缩进一次。
注意：你不能同时设置它们，只能选其中一种方式来进行生成临时目录文件。如果不需要自定义缩进规则的话将两者都设置为null。
IndentByDirs: null,
IndentByTitle: null,
}
}
}
module.exports = {
confs
}
这与模块引用方法差不多，只是为了尽可能简单地重新定义默认值因而做了一些改变......总之感觉很复杂！使用JSON格式的配置文件不方便使用可变型的追加内容——尤其在批量创建新文档的时候，比如日期、时间这些可变的内容。比较了下，比起使用命令行还不如直接部署一个临时npm项目......
注意：类属性configs.includes 和 configs.excludes 的值以及目录文件(例如：summary.md)的内容决定了函数的返回值。
.create(template[,Function]) -创建目录列表中的文件，已存在的文件会跳过。这需要有"summary.md" 文件或者其他有类似列表的文件。
Function 是必须提供的并且须定义至少一个参数给内部标题使用。定义的函数须返回字符串内容。例如：
example.create( (title)=>{ return `${title}\n===\n Add more contents.`});函数的返回值将作为新文件的内容，如果函数返回
undefined那么新文件的内容将是类似于："# example"
.update() -更新目录列表。更新的内容会存放在临时目录文件中（默认路径为：./_summary.md）
.localDocs().docPaths -返回本地已存在文档的路径。数组，结果类似于：["example.md",...]。
.localDocs().docs -返回本地已存在文档的标题和路径。数组，结果类似于：[{title:'example',path:'example.md'},...]。
.summaryList() -返回目录列表的链接信息。结果类似于：[{title:'example',path:'example.md'}]。
.docs_not_listed_in_summary() -返回已存在于本地，但还未被列入目录文件的文档信息。结果类似于：[{title:'example',path:'example.md'}]。
._summaryStatus_hasProblems().problem_with_URL -返回目录文件中未设置路径或者URL指向的文件不存在的列表。结果类似于：[{title:'example',path:'example.md'}]。或者[]。
._summaryStatus_hasProblems().problem_with_Text -返回目录文件夹中链接文本为空的链接列表。结果类似于：[{title:'example',path:'example.md'}]或者 []。
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型