关于 Honkit
Honkit
是一个基于 Node.js
、使用 Markdown
构建静态页面的命令行工具,通常被用于制作静态博客、软件/程序说明文档等。Honkit
是 Gitbook
(已停止更新) 的分支之一,兼容 Gitbook
的插件。本文使用 Docker 搭建 Honkit
环境.#
配置环境
- 服务器:硅云c1m1
- 系统:Ubuntu 22.04 LTS 64位
- SSH工具:FinalShell SSH
安装Docker
在 Ubuntu 上,虽然可以通过 Ubuntu 的官方仓库直接安装 Docker,但是这种方法通常无法获取到最新的 Docker 版本,而且安全更新也可能延迟。
因此,推荐从官方仓库进行安装,确保可以用上最新版本并和自动更新,由于Docker官方仓库可能存在无法访问的情况,本文采取使用阿里源
安装
更新软件包并安装必要软件
sudo apt update
sudo apt install apt-transport-https ca-certificates curl gnupg
## 信任 Docker 的 GPG 公钥
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://mirrors.aliyun.com/docker-ce/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
添加软件源信息
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://mirrors.aliyun.com/docker-ce/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
更新源
sudo apt-get update
安装Docker
# 安装
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
# 查看Docker版本
sudo docker version
# 查看Docker运行状态
sudo systemctl status docker
# Ctrl-C 退出
安装Docker 命令补全工具
sudo apt-get install bash-completion
sudo curl -L https://raw.githubusercontent.com/docker/docker-ce/master/components/cli/contrib/completion/bash/docker -o /etc/bash_completion.d/docker.sh
source /etc/bash_completion.d/docker.sh
小结
以上我们便完成了Docker的安装。
安装Honkit
HonKit 已经提供了 honkit/honkit 的 Docker 镜像。
该镜像内含用于生成 PDF/epub 的内置依赖项,因此直接拉去即可。
# 拉取
docker pull honkit/honkit
# 安装完成后通过以下代码检查
docker image
初始化
切换到希望防止Honkit
文件的目录,使用以下代码初始化
docker run -v `pwd`:`pwd` -w `pwd` --rm -it honkit/honkit honkit init .
初始化后会自动生成REAEME.md
和SUMMARY.md
文件,这两个文件是启动 Honkit 必备的文件。
启动服务器测试
docker run -it --init -p 4000:4000 -v `pwd`:`pwd` -w `pwd` --rm honkit/honkit honkit serve
打开浏览器输入ip:4000
或者http://localhost:4000
访问,出现以下界面。安装成功。
值得一提的是,使用Docker目前仅能完成构建,在主题美化和插件上还存在难度。