Gostatic 静态网站生成器技术文档

1. 安装指南

Gostatic 是一个静态网站生成器，其安装非常简单。您只需从发布页面下载相应的二进制文件即可。以下是自动化下载最新版本的示例脚本：

URL=$(curl -s https://api.github.com/repos/piranha/gostatic/releases | awk '/download_url.*64-linux/ { print $2; exit }')
curl -Lso gostatic $(URL)
chmod +x gostatic

对于 MacOS 用户，下载的文件将被隔离。要使用它，您需要确保 MacOS 知道您的操作：

xattr -r -d com.apple.quarantine gostatic

如果您想从源代码编译，可以使用以下命令：

go get https://github.com/piranha/gostatic

2. 项目的使用说明

要开始使用 Gostatic，请运行以下命令以在 my-site 目录中生成一个基本网站：

gostatic -i my-site

该命令会在 my-site 目录中创建一个基本的 config 文件，您应该编辑它以设置相关变量。src 目录包含网站的源文件，您可以根据需要创建新的博客文章或页面。运行以下命令查看 src 目录的处理方式：

gostatic -fv config

site.tmpl 文件定义了您可以使用的模板，而 Makefile 文件提供了便利的构建和监视命令。

3. 项目API使用文档

Gostatic 的 API 使用文档详细说明了如何使用其模板系统。以下是一些关键的接口和功能：

• 全局函数：在模板中可用的全局函数。
• Page 接口：代表单个页面的接口，提供页面相关的属性和方法。
• PageList 接口：代表页面列表的接口，可用于迭代和处理多个页面。
• Site 接口：代表整个网站的接口，提供对网站全局设置和信息的访问。

4. 项目安装方式

Gostatic 的安装方式如下：

1. 从发布页面下载适用于您操作系统的二进制文件。
2. 将下载的二进制文件解压到您的系统中，并赋予执行权限。
3. 或者，如果您想从源代码编译，可以使用 go get 命令。

请按照以上步骤操作，以成功安装 Gostatic 并开始构建您的静态网站。