安装
$ npm install -g cwg-simple-book
$ cbook --readme
说明
-
这是一个文档的编写工具
-
使用markdown语法编写文档
-
支持上传图片或文件,并引入文档
-
目前扩充了一种语法用来与本地环境交互,见readme的
SVID_HTML
-
支持以只读模式打开
-
支持编写时同步预览,并高亮显示当前修改处
-
支持直接获取json/jsonp文档数据,可自定义文档展示界面
-
支持以node模块形式被其他项目引用
-
支持以命令行直接启动进程
注意事项
-
因为用标题直接映射了文件名,因此不同文档的标题请勿重复
-
标题被删除不会导致文档本身被删除,同理,文档本身被删除不会导致文档内引用的文件被删除