Gitbook的安装和部署

安装

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部署

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

利用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

posted @ 2023-02-12 17:05  快乐的提千万  阅读(393)  评论(0编辑  收藏  举报