天天看點

gitbook的安裝

【前端工具】nodejs+npm+vue 安裝

安裝

npm install gitbook-cli -g
           

gitbook指令:

gitbook init //初始化目錄檔案
gitbook help //列出gitbook所有的指令
gitbook --help //輸出gitbook-cli的幫助資訊
gitbook build //生成靜态網頁
gitbook serve //生成靜态網頁并運作伺服器
gitbook build --gitbook=2.0.1 //生成時指定gitbook的版本, 本地沒有會先下載下傳
gitbook ls //列出本地所有的gitbook版本
gitbook ls-remote //列出遠端可用的gitbook版本
gitbook fetch 标簽/版本号 //安裝對應的gitbook版本
gitbook update //更新到gitbook的最新版本
gitbook uninstall 2.0.1 //解除安裝對應的gitbook版本
gitbook build --log=debug //指定log的級别
gitbook builid --debug //輸出錯誤資訊
           

基本也就是上線的操作指令,常用的就是前面的6個了。

在執行完gitbook init後,會給自動生成一個模闆,剩下的就是修改模闆為你自己的文章了。

配置

自己在項目根目錄下添加book.json檔案

{
    "plugins": [
      "-lunr", 
      "-search", 
      "search-pro",
      "collapsible-menu",
      "anchor-navigation-ex",
      "tbfed-pagefooter",
      "disqus",
      "expandable-chapters",
      "advanced-emoji",
      "pageview-count"
    ],
    "title": "我的test",
    "description" : "隻是試試",
    "language" : "zh-hans",
    "pluginsConfig": {
        "tbfed-pagefooter": {
            "copyright":"Copyright &copy ershouche-FE 2019",
            "modify_label": "檔案修訂時間:",
            "modify_format": "YYYY-MM-DD HH:mm:ss"
        },
        "disqus": {
          "shortName": "gitbookuse"
        }
    }
  }
           

使用 gitbook install 下載下傳插件,可能有點慢

本地預覽

gitbook serve這個可以在本地生成預覽。本地啟動http://localhost:4000即可預覽。

釋出

當然寫文章不隻是為了自己看,需要分享出去,這裡就需要gitbook build了,

執行完gitbook build之後,目錄下面會生成一個_book這裡就是生成的靜态網頁資源,裡面有個index.html,這個是網站的入口。

想在阿裡雲伺服器上面部署GitBook,前提是你的阿裡雲伺服器已經安裝了GitBook。其他伺服器也是同樣情況。

上面說了gitbook build之後,目錄下面會生成一個_book這裡就是生成的靜态網頁資源,裡面有個index.html,這個是網站的入口。我用GitBook生成的書也是用Nginx部署的。

在/etc/nginx/sites-enabled的目錄下面,建立一個.conf格式的檔案api_gitbook.conf。檔案裡面的代碼如下:

利用nginx部署

nginx基礎請看我的nginx教程

server {
	listen 4000;
	server_name localhost;
	location / {
		root /home/apibook/_book;
		index index.html;
		try_files $uri $uri/ =404;
	}
}
           

利用Jenkins自動生成

Jenkins基礎請檢視我的教程

[ -e back-wiki.tar ] && rm -f back-wiki.tar
tar cf back-wiki.tar back-wiki/*
sudo mv back-wiki.tar /home/

cd /home/
[ -e back-wiki.bak ] && sudo rm -rf back-wiki.bak
sudo mv back-wiki back-wiki.bak
sudo tar xf back-wiki.tar
[ -e back-wiki.bak/node_modules ] && sudo mv  back-wiki.bak/node_modules back-wiki/

cd /home/back-wiki
if [ "$add_module" = "true" ];
then
	sudo gitbook install
fi

sudo gitbook build