最近在用gitBook整理团队里的组件文档,目前已整理完毕,以一份类似book的形式来展示和存储,视觉上看还是不错的。
页面展示如下:
页面也可以满足日常的搜索功能,也可以跳转,展开目录等,还有不少gitbook的插件供我们使用。
gitbook简介
gitbook其实在我的理解上就是一个使用git操作的markdown合集,他可以将所有md文件整合成一本书。
gitbook常用的几个简单操作命令
npm install gitbook-cli -g 安装gitbook npm
gitbook install 安装插件
gitbook build 构建成Html文件,默认在_book目录下
gitbook serve 启动服务,会生成一个本地地址进行浏览
gitbook --help 获取更多指令,一般以上的几个就满足日常操作需求了
顺便一提编辑工具GitBook Editor
之前有用过GitBook Editor 这个,可以直接编辑预览,还是挺方便的,但是下载资源需要网上另外找。
该软件可以直接创建book,并且在book里创建目录,编辑。
操作页面看着也是比较可视化的,编辑完book,可以设置仓库地址,直接save后上传,等于做了一遍commit和push。
当然Typora也还是挺香的。