docCentor
**本项目仅供公司内部人员使用,请勿外传!**本项目是一个文档索引项目,相当于一个索引目录,解决内部信息分散的问题,不改变原有存储方式仅作登录管理,方便索引查看。
收集内容包含但不限于内部规范、开发文档、经验分享等。
文档整理维护
- 目前由研发部维护,需要登记的文档信息以txt、md、链接、邮件等形式发送到
renzheng@topnet.net.cn
或 企业微信
本地搭建--[管理员]
本地克隆项目
使用gitbook进行构建,安装gitbook,用于生成可查看的静态页面。由于本项目使用md文件,本机最好使用Typora进行文件编写
gitbook 安装需要先安装nodejs,最好是9.x版本,否则会有兼容问题。
SUMMARY.md 为目录树,需要修改这个目录以增加新内容
编写完使用gitbook build 进行构建,生成_book目录即可提交git查看
目前有 cooperation(协作相关)、share(分享)、version(版本管理)目录,目录根据需要进行添加
在构建完成后,git提交即可通过 https://bp.jydev.jianyu360.cn/BaseService/docCentor/raw/master/_book/index.html 查看(需要修改host 192.168.3.207 bp.jydev.jianyu360.cn),目前使用的git 进行文档预览(也可直接把_book部署在nginx下),本地则使用gitbook serve 即可访问预览。