快速上手

安装 Hollow

go install github.com/zbysir/hollow@latest

或者直接使用 Docker (更推荐): https://hub.docker.com/r/bysir/hollow

预览主题

这是一个可选步骤，用于快速查看一个主题的样子

docker run -p 9400:9400 bysir/hollow:master server -t https://github.com/zbysir/hollow-theme/tree/master/hollow

开始你的创作

• 创建项目文件夹, 如. book，然后进入 book 目录
• 创建 contents 文件用于存储内容
• 创建一些内容, 如文件名为 contents/hello.md, 内容如下:

  ---
  title: "Hello Hollow"
  date: 2022-03-22
  ---
  # Hello Hollow
  write something here
  

• 现在你的项目结构看起来是这样的:

  ./
  └── contents/
      └── hello.md
  

• 预览你的网站
  • 运行 Hollow 服务

    docker run -v ${PWD}:/source -p 9400:9400 bysir/hollow:master server -t https://github.com/zbysir/hollow-theme/tree/master/hollow
    

  • 打开任何浏览器访问 http://localhost:9400

发布

下面的命令将会构建文件到 .dist 目录下

docker run -v ${PWD}:/source bysir/hollow:master build -o /source/.dist -t https://github.com/zbysir/hollow-theme/tree/master/hollow

./
├── .dist/
└── contents/
    └── hello.md

随后将 .dist 中的所有文件部署到 Github page 上就完成了

或者 使用 Github Actions 部署