Gostatic 静态站点生成器使用教程

Gostatic 静态站点生成器使用教程

gostatic Fast static site generator 项目地址: https://gitcode.com/gh_mirrors/gos/gostatic

1. 项目介绍

Gostatic 是一个快速且高效的静态站点生成器。它通过跟踪文件变化来优化编译速度，并且提供了一个类似于 Makefile 的配置框架，使得用户可以轻松理解和编写自定义配置。Gostatic 的主要特点包括：

• 无运行时依赖：只需一个二进制文件即可运行。
• 依赖跟踪：只重新渲染发生变化的页面。
• Markdown 支持：通过 goldmark 支持 Commonmark。
• 简单配置语法：类似于 Makefile 的配置语法。
• 灵活的过滤系统：支持自定义过滤器。
• 分页支持：适用于博客等需要分页的场景。
• 与外部命令和脚本兼容：可以与外部工具和脚本协同工作。
• HTTP 服务器和监视器：支持实时渲染和文件变化监视。

2. 项目快速启动

安装

首先，从 releases 页面 下载适用于你操作系统的二进制文件。如果你需要自动化下载最新版本，可以使用以下脚本（根据需要修改 64-linux 为你的系统类型）：

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 上，下载的文件可能会被隔离，需要解除隔离：

xattr -r -d com.apple.quarantine gostatic

当然，你也可以通过 go get 从源码编译：

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

快速启动

1. 生成基本站点：

   运行以下命令生成一个基本的站点目录：

   gostatic -i my-site
   

   这将在 my-site 目录中生成一个基本的配置文件 config，你需要编辑该文件以设置相关变量。

2. 编辑配置文件：

   配置文件中包含了对 src 目录中文件的处理方式描述。src 目录包含站点的源文件（目录名称可以在配置中更改）。你可以参考该目录结构创建新的博客文章或页面。

3. 查看处理过程：

   运行以下命令查看 src 目录中的文件如何被处理：

   gostatic -fv config
   

4. 构建站点：

   site.tmpl 文件定义了你可以使用的模板。你可以看到这些模板在配置文件中被提及。最后，有一个 Makefile 文件，方便你构建站点：

   make
   

   或者运行监视器和服务器以实时查看站点变化：

   make w
   

3. 应用案例和最佳实践

应用案例

Gostatic 适用于需要快速生成静态站点的场景，例如个人博客、文档站点、项目主页等。由于其高效的依赖跟踪和快速的编译速度，Gostatic 特别适合需要频繁更新内容的站点。

最佳实践

• 配置优化：合理使用配置文件中的规则，确保每个文件只匹配一个规则，避免多个规则冲突。
• 模板复用：利用模板文件中的多个模板，减少重复代码，提高维护性。
• 自动化部署：结合 CI/CD 工具，自动化站点的构建和部署过程。

4. 典型生态项目

Gostatic 作为一个静态站点生成器，可以与其他工具和项目结合使用，形成完整的生态系统。以下是一些典型的生态项目：

• CI/CD 工具：如 GitHub Actions、GitLab CI 等，用于自动化站点的构建和部署。
• 版本控制系统：如 Git，用于管理站点的源代码。
• 静态文件托管服务：如 GitHub Pages、Netlify、Vercel 等，用于托管生成的静态站点。
• 前端工具链：如 Webpack、Gulp 等，用于处理前端资源（如 CSS、JavaScript）。

通过这些工具的结合，可以构建一个高效、自动化的静态站点开发和部署流程。

gostatic Fast static site generator 项目地址: https://gitcode.com/gh_mirrors/gos/gostatic