Lib.rs

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

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

平台

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

快速开始

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

数据目录布局和文件格式

这是您的网站数据。

配置

gazetta.yaml

这是网站的核心配置。它可以用来指定在渲染网站上的任何页面时可用的一些共享变量。它必须指定

• title：网站的标题。
• base：网站的基URL。

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

并可以指定一组导航链接

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头。此头必须包括一个title以及您指定的渲染器所需的任何其他内容。默认情况下，该头还可以包括

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

如果您使用的是默认渲染器，该头还可以包括

• author：页面作者。
• about：此字段表示此页面是关于某人的。提供的人员信息将被渲染在页面的顶部。

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

索引

索引字段可以是布尔值或具有以下可选字段的表

# 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毫秒。