GitBook + Git + PyCharm开发文档中心

本文是所在公司，使用GitBook开发文档中心的一些步骤。
已脱敏，仅作记录。

前言

Modern book format and toolchain using Git and Markdown
这个工具链 (GitBook) 是一个使用 Git 和 Markdown 来构建书籍的工具。

基于 Node.js 的命令行工具，支持 Markdown 和 AsciiDoc 两种语法格式，可以输出 HTML、PDF、eBook 等格式的电子书。

一、开发环境：安装Node.js、Git、GitBook

1、安装Git

• 官网：https://git-scm.com/downloads
• 安装完成后，终端内执行 git --version，验证是否安装成功。

2、安装Node.js

• 官网：https://nodejs.org/en/
• 安装完成后，终端内执行 node -v、npm -v，验证是否安装成功。
• 若 npm -v无反应，可参照：https://www.jianshu.com/p/e86357cf99ea

3、（非必须）使用公司内部npm包仓库

• http://tnpm.oa.com/

4、安装GitBook

执行npm install -g gitbook-cli，若有网络问题，执行 tnpm install -g gitbook-cli

ps. 文件夹权限问题：chmod -R 777 文件名

二、开发步骤

1、Clone代码

• 执行命名git clone 代码地址
• 证书错误的话可执行 git config --global http.sslVerify false

2、启动GitBook（staffwifi）

• 执行命令gitbook serve（启动本地预览），命令执行后，会对 Markdown 文档默认转换为 html 格式，访问 http://localhost:4000，即可看到开发的web页面。

三、提交代码到版本库（officewifi）

• 1、在Pycharm控制台执行gitbook build，默认将生成的静态网站输出到 _book 目录
• 2、执行命令git add ./ 或 git add 文件名（添加文件到暂存区）
• 3、第一次时需要账密：
  git config --global user.email "[email protected]”
git config --global user.name "xx"
• 4、执行命令git commit -m “变更内容文案”（提交暂存区到仓库区 ）
• 5、执行命令git push（上传本地指定分支到远程仓库 ）

四、发布代码到Dev、Pro环境

1、登录机器 ssh [email protected] -p 36000、密码
2、进入代码目录cd /data/release/document
3、执行命令 git pull（取回远程仓库的变化，并与本地分支合并，需要账密）
4、Dev、Pro环境查看修改的内容

Git常用命令.png