Lib.rs

Gazetta 是一个用 Rust 编写的静态网站生成器。它包含四个部分

1. Horrorshow，一个基于 Rust 宏的 HTML 生成器。
2. 框架。这个库集合包含了大部分逻辑，负责从您的网站数据文件生成模型和视图。
3. 渲染器。这里是实际的 HTML 渲染逻辑所在。如果您需要精细控制您网站的 HTML，应该从这个仓库分叉。然而，99% 的情况下，您应该能够在不修改此项目的情况下充分定制您的网站。
4. 您的网站数据。这包括您网站的内容和资产（样式表/JavaScript）。您可以在这里找到我的，以及一个用于启动的简单示例网站这里。

平台

我只在 64 位 Linux 上测试了 Gazetta，但它应该适用于所有 *nix 平台。然而，它可能无法在 Windows 上工作（我假设路径中的正斜杠）。欢迎提交补丁！

快速入门

1. 下载并编译 gazetta-bin (cargo build --release)。除非您想支付 15x-30x 的性能惩罚，否则请以发布模式构建。
2. 分叉并克隆 gazetta-bootstrap。
3. 编辑配置、主页和主题，使其符合您的喜好。
4. 手动创建新页面或使用 gazetta 二进制文件创建新页面。例如： gazetta new blog "Hello World" 将创建一个“Hello World”博客文章。
5. 运行 gazetta render /path/to/output（在仓库中的任何位置）以渲染您的网站。

数据目录布局和文件格式

这是您的网站数据。

配置

gazetta.yaml

这是网站的内核配置。它可以用来指定在渲染网站上的任何页面时可用的高级变量。它必须指定

• 标题：网站的标题。
• 基础：网站的基础 URL。

如果你使用默认渲染器（gazetta-bin），你还必须指定一个 作者 格式（请参阅人员部分）

并且可以指定一组导航链接

nav:
# If relative, href is relative to the site base.
  - title: href

资源

/
└── assets/
    ├── javascript/
    │   ├── 0-example1.js
    │   └── 1-example2.js
    ├── stylesheets/
    │   ├── 0-example1.css
    │   └── 1-example2.css
    └── icon.png

所有文件都是可选的。

• icon.png：网站的图标。
• javascript：网站的 JavaScript 文件。它们将在构建时按字典顺序连接。
• stylesheets：网站的样式表。它们将在构建时按字典顺序连接。

assets 中的所有其他文件都将被忽略。

条目

一个条目由以下内容组成

1. 一个必需的索引文件（index.txt、index.html 或 index.md）。
2. 一个可选的 static 目录，其中包含静态文件。
3. 任意数量的子条目。

所有索引文件 必须 有一个 YAML 头部。此头部必须包括一个 标题 以及你的指定渲染器所需的其他任何内容。默认情况下，此头部还可以包括

• 日期：格式为 YYYY-MM-DD 的日期。
• 索引：这表示当前页面是一个索引。如果指定，所有子页面都将作为子页面附加到页面。有关更多信息，请参阅索引。
• cc：将此页面链接到指定的索引页面，就像它是一个子页面一样。这对于使页面显示在多个标签/类别中非常有用。

如果你使用默认渲染器，头部还可以包括

• 作者：页面的作者。
• 关于：此字段表示此页面是关于某人的。提供的个人信息将在页面的顶部显示。

静态目录内的目录和文件将原样复制到输出目录。这是一个放置每页静态媒体的好地方。

索引

索引字段可以是布尔值或包含以下可选字段的表格

# The sort direction and field: [+-](date|title)
sort: date

# How many entries to list per page or false to not paginate.
paginate: false

# The directories to include in the index (in addition to explicitly CCed
# entries).
directories: .

# The maximum number of entries to include in the index or false to include all
# entries.
max: false

人员

在指定人员时，你可以直接写下他们的名字或使用以下表格

name: My Name # Mandatory
email: email
photo: photo
key: pgp_key_url
nicknames:
  - first nick
  - second nick
also: # A list of profiles around the web.
 - "GitHub": github_url # example
 - "reddit": reddit_profile_url  # example

代码质量

我对整体架构很满意，但一些代码可能需要一些关爱（主渲染函数尤其糟糕）。再次，欢迎补丁。

性能

Gazetta非常快；这就是为什么我不显示进度。然而，还有改进的空间

1. Gazetta做了很多系统调用（文件 I/O）。我们可能可以显著减少这一点。在我的机器上，超过一半的运行时间是系统时间。
2. yaml-rust 很慢（根据 callgrind）。我考虑过使用 toml，但切换会很痛苦。
3. 索引构建算法是 Θ(num_indices*num_entries)。这可以减少到 Θ(num_entries)，但是 num_indices 通常相当低，所以这只有在我们可以将新算法运行时间的常数乘数保持低的情况下才有意义。
4. 我们真的在乎吗？我的网站（约75页）在我的笔记本电脑上构建只需50毫秒。