版本控制建议

本文为 DocMan 官方对需要对文档项目进行版本控制的用户提供的建议。

文档项目版本控制

DocMan 主张 DocMan 站点生成器项目与文档项目分离。文档项目不依赖于 DocMan ，只需采用约定的记法编写目录索引文件 index.json 即可。DocMan 依据目录索引文件 index.json 生成文档类站点。

DocMan 的 .gitignore 默认屏蔽 docs 和 dist 文件夹。用户对文档项目进行版本控制，并把文档项目克隆到 DocMan 的 docs 文件夹下。

cd /path-to-docman/docs
git clone xxx/my_doc

更新文档项目后，在服务器上拉取文档项目更新，然后运行 DocMan 重新生成文档站点即可。

拉取文档项目更新

cd /path-to-docman/docs/my_doc
git pull

运行 DocMan 生成站点

npm run build

新的 DocMan 版本将支持更多新特性，并且我们尽最大可能保证新的程序能兼容旧的配置文件。

切换到 DocMan 实例目录

cd /path-to-docman

拉取 DocMan 更新

git pull

更新依赖

npm install