工具选择:Gitbook + GitHub Pages
大概流程:
首先在本地编写md文件,然后生成对应的html文件,最后将这些html文件推送到github对应的gitbook仓库。
具体步骤:
(一)本地gitbook安装与初始化
-
在本地安装 gitbook工具,详细步骤网上很多,不赘述!
-
在本地创建一个目录,切换至该目录,执行
gitbook init
初始化;
然后,执行gitbook serve
可以通过访问 localhost:4000 来预览效果。 -
同样在该目录内,执行命令
gitbook build
,它会将相应的md文件转为相应的html文件,就在 它创建的_book
目录中。
(二)GitHub Pages配置
-
在github创建一个名为 gitbook的仓库,同时在该仓库创建
gh-pages
分支(将该gh-pages分支作为GitHub Pages的发布源)。 -
将本地
_book
目录中的内容推送到 gitbook的仓库的gh-pages
分支,然后我们便可以通过 https://userName.github.io/gitbook/ 来访问我们的gitbook.
(三)日常编辑!!!<<==
- 使用 Gitbook Editor 或者 Typora 编辑md文档。
- 执行命令
gitbook build
进行构建,然后推送到 gitbook的仓库的gh-pages
分支。
(本人目前一般是 先构建至_book目录,然后复制到本地的克隆仓库目录,再在仓库目录内进行推送)
相关拉取/推送命令:
将 github项目的 gh-pages分支 克隆到 本地的某目录 如下:
git clone -b gh-pages https://github.com/zhongyuanzhao000/gitbook.git "D:Wikigh-pages"
使用 git clone 命令复制的项目需要 更新并推送时,
cd <project目录>
git add * # 提交所有更改信息(删除 增加文件)
git commit -m "update" # 提交更改文件的标签
git push origin gh-pages # 推送到gh-pages分支