用honkit替代gitbook

gitbook在npm版本高后安装使用有很多问题，💩一样

stackoverflow找到了替代品 honkit

官网链接：https://honkit.netlify.app/

安装使用

1
2
sudo npm uninstall gitbook-cli -g
sudo npm install honkit --save-dev

进入到目标文件夹下执行：

1
npx honkit init

生成README.md和SUMMARY.md

upload successful

之后就可以编辑内容，然后更新到git repo上

本地查看可使用 sudo npx honkit serve 在 localhost:4000 进行预览

使用S3静态网站建立文档中心

  • 执行 sudo npx honkit build， 生成 _book文件夹
  • 将_book所有对象上传到指定的对象存储的桶里

例：这里我建了个桶atlas-doc, 利用s3cmd命令上传到自己的对象存储里

1
2
cd _book/
s3cmd put ./ --recursive s3://atlas-doc/

upload successful

  • 配置website静态网站托管

upload successful

  • 配置S3 BucketPolicy，设置该桶内对象全局可读
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
## cat policy.json

{
   "Version": "2012-10-17",
   "Statement": [{
   "Effect": "Allow",
   "Principal": {"AWS":["*"]},
   "Action": ["s3:GetObject"],
   "Resource": [
           "arn:aws:s3:::atlas-doc/*"
   ]
   }]
}

## 设置BucketPolicy

s3cmd setpolicy policy.json s3://atlas-doc

最终效果：

upload successful

upload successful