gozer
1.0.0
Gozer 是一个用 Golang 编写的快速且简单的静态站点生成器。
使用 Gozer 的示例网站:
您可以通过首先安装 Go 编译器然后运行以下命令来安装 Gozer:
go install git.sr.ht/~dvko/gozer@latest
运行gozer new
快速生成空目录结构。
├── config.toml # Configuration file
├── content # Posts and pages
│ └── index.md
├── public # Static files
└── templates # Template files
└── default.html
然后,运行gozer build
来生成您的网站。
运行gozer build
后,放置在content/
目录中的任何 Markdown 文件都会在构建目录中生成 HTML 页面。
例如:
content/index.md
创建一个文件build/index.html
,以便可以通过 HTTP 访问/
content/about.md
创建一个文件build/about/index.html
以便可以通过 HTTP 访问/about/
。 运行不带任何参数的gozer
以查看帮助文本。
Gozer - a fast & simple static site generator
Usage: gozer [OPTIONS] <COMMAND>
Commands:
build Deletes the output directory if there is one and builds the site
serve Builds the site and starts an HTTP server on http://localhost:8080
new Creates a new site structure in the given directory
Options:
-r, --root <ROOT> Directory to use as root of project (default: .)
-c, --config <CONFIG> Path to configuration file (default: config.toml)
content/
目录中的每个文件都应以.md
结尾,并具有指定页面标题的 TOML 前面内容:
+++
title = " My page title "
+++
Page content here.
每个页面的默认模板是default.html
。您可以通过在前面设置template
变量来覆盖它。
+++
title = " My page title "
template = " special-page.html "
+++
Page content here.
模板由 Go 的标准html/template
包提供支持,因此您可以使用此处描述的所有操作。
每个模板都会接收以下变量集:
Pages # Slice of all pages in the site
Posts # Slice of all posts in the site (any page with a date in the filename)
Site # Global site properties: Url, Title
Page # The current page: Title, Permalink, UrlPath, DatePublished, DateModified
Title # The current page title, shorthand for Page.Title
Content # The current page's HTML content.
Page
变量是以下对象的实例:
type Page struct {
// Title of this page
Title string
// Template this page uses for rendering. Defaults to "default.html".
Template string
// Time this page was published (parsed from file name).
DatePublished time.Time
// Time this page was last modified on the filesystem.
DateModified time.Time
// The full URL to this page, including the site URL.
Permalink string
// URL path for this page, relative to site URL
UrlPath string
// Path to source file for this page, relative to content root
Filepath string
}
要显示最近 5 篇帖子的列表:
{{ range (slice .Posts 0 5) }}
<a href="{{ .Permalink }}">{{ .Title }}</a> <small>{{ .DatePublished.Format "Jan 02, 2006" }}</small><br />
{{ end }}
Gozer 的开发发生在 Sourcehut 上。通过电子邮件接受补丁。
Gozer 在 MIT 许可下开源。