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

1. 项目目录结构及介绍

Plenti 的项目目录结构如下：

plenti/
├── cmd/
│   └── plenti/
│       └── main.go
├── defaults/
│   ├── readers/
│   │   └── reader.go
│   ├── writers/
│   │   └── writer.go
├── gitignore
├── goreleaser.yml
├── Dockerfile
├── LICENSE
├── README.md
├── go.mod
├── go.sum
└── main.go

目录说明：

• cmd/: 包含项目的入口文件，plenti 子目录中的 main.go 是程序的启动点。
• defaults/: 存放默认配置文件和辅助工具。
  • readers/: 读取器相关的代码。
  • writers/: 写入器相关的代码。
• gitignore: Git 忽略文件，指定 Git 不应跟踪的文件和目录。
• goreleaser.yml: GoReleaser 配置文件，用于自动化发布。
• Dockerfile: 用于创建 Docker 容器的配置文件。
• LICENSE: 项目的许可文件，Plenti 使用 Apache-2.0 许可。
• README.md: 项目的自述文件，包含项目的基本信息和说明。
• go.mod: Go 模块文件，用于管理项目依赖。
• go.sum: 包含 go.mod 文件中指定的模块的校验和。
• main.go: Plenti 程序的主入口文件。

2. 项目的启动文件介绍

项目的启动文件是 cmd/plenti/main.go。这个文件定义了 Plenti 命令行界面的主要逻辑。以下是 main.go 的基本结构：

package main

import (
    "github.com/plentico/plenti/cmd/plenti/cli"
)

func main() {
    cli.Execute()
}

在 main 函数中，调用了 cli.Execute() 方法来启动命令行界面。cli 包负责解析命令行参数，并根据这些参数执行相应的操作。

3. 项目的配置文件介绍

Plenti 使用 goreleaser.yml 文件来自动化发布流程。这个文件通常位于项目根目录下，以下是配置文件的一个基本示例：

builds:
- main: ./cmd/plenti
  binary: plenti
  goarch:
    - amd64
    - arm64
  goos:
    - darwin
    - linux
    - windows
dist:
  goproxy:
    - https://goproxy.cn
release:
  name: plenti
  notes: |
    发布说明...

这个配置文件指定了以下内容：

• builds: 指定构建的详细信息，包括主入口文件的位置、生成的二进制文件名、支持的架构和操作系统。
• dist: 包含分发相关的配置，例如 Go 代理设置。
• release: 指定发布时的名称和发布说明。

使用 goreleaser 工具时，它会读取这个配置文件并根据指定的参数构建和发布项目。