我的Wiki搭建(Gitbook + GitHub Pages)

工具选择:Gitbook + GitHub Pages

大概流程:

首先在本地编写md文件,而后生成对应的html文件,最后将这些html文件推送到github对应的gitbook仓库。html

具体步骤:

(一)本地gitbook安装与初始化git

  1. 在本地安装 gitbook工具,详细步骤网上不少,不赘述!github

  2. 在本地建立一个目录,切换至该目录,执行gitbook init初始化;
    而后,执行gitbook serve能够经过访问 来预览效果。 工具

  3. 一样在该目录内,执行命令gitbook build,它会将相应的md文件转为相应的html文件,就在 它建立的_book目录中。ui

(二)GitHub Pages配置code

  1. 在github建立一个名为 gitbook的仓库,同时在该仓库建立 gh-pages 分支(将该gh-pages分支做为GitHub Pages的发布源)。htm

  2. 将本地_book目录中的内容推送到 gitbook的仓库的 gh-pages 分支,而后咱们即可以经过 https://userName.github.io/gitbook/ 来访问咱们的gitbook.github-pages

(三)平常编辑!!!<<==文档

  1. 使用 Gitbook Editor 或者 Typora 编辑md文档。
  2. 执行命令gitbook build进行构建,而后推送到 gitbook的仓库的 gh-pages 分支。
    (本人目前通常是 先构建至_book目录,而后复制到本地的克隆仓库目录,再在仓库目录内进行推送)
相关拉取/推送命令:

将 github项目的 gh-pages分支 克隆到 本地的某目录 以下:get

git clone -b gh-pages https://github.com/zhongyuanzhao000/gitbook.git "D:Wiki\gh-pages"

使用 git clone 命令复制的项目须要 更新并推送时,

cd <project目录>        
git add *                     # 提交全部更改信息(删除 增长文件)
git commit -m "update"        # 提交更改文件的标签
git push origin gh-pages      # 推送到gh-pages分支
相关文章
相关标签/搜索