jkl静态站点生成器技术文档

本文档将详细介绍如何安装、使用jkl静态站点生成器，以及如何使用其提供的API。

1. 安装指南

jkl是一款使用Go语言编写的静态站点生成器，基于Jekyll。以下是安装jkl的步骤：

首先，你需要下载以下依赖：

go get github.com/russross/blackfriday
go get launchpad.net/goyaml
go get launchpad.net/goamz/aws
go get launchpad.net/goamz/s3
go get github.com/howeyc/fsnotify

编译完成后，可以使用以下命令进行安装：

sudo install -t /usr/local/bin jkl

如果你使用的是x64位Linux系统，可以直接下载预编译的二进制文件：

wget https://github.com/downloads/bradrydzewski/jkl/jkl
sudo install -t /usr/local/bin jkl

2. 项目使用说明

jkl的使用非常简单，以下是一些常用命令和选项：

Usage: jkl [OPTION]... [SOURCE]

  --auto           文件修改时自动重新生成站点
  --base-url       从指定的基础URL服务网站
  --source         更改Jekyll转换文件的目录
  --destination    更改Jekyll写入文件的目录
  --server         启动一个服务器，托管你的 Site 目录
  --server-port    更改Jekyll服务器运行的端口
  --s3             将 Site 目录复制到 S3
  -v, --verbose    使用详细输出
  -h, --help       显示帮助信息并退出

示例:
  jkl                  从当前工作目录生成站点
  jkl --server         生成站点并在 localhost:4000 上服务
  jkl /path/to/site    从指定源目录生成站点

自动生成

如果你在服务器模式下运行网站，并且使用了 --server 选项，你可以通过添加 --auto 选项来指示jkl在文件修改时自动重新编译你的网站。请注意，此功能仅在Linux系统上可用。

3. 项目API使用文档

jkl目前没有官方的API文档，但是它支持与Jekyll相似的目录结构和YAML前端元数据。你可以参考Jekyll官方wiki了解相关内容，但请记住，jkl使用Go模板而不是Liquid模板。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细描述，这里不再赘述。

以上就是关于jkl静态站点生成器的技术文档。希望这些信息能够帮助你顺利使用jkl。