Site

Site 是一个快速、简单、有见地的静态网站生成器，使用 Rust 编写。主要特点包括

• 使用 Markdown 格式编写内容。Site 使用 pulldown_cmark 作为具有扩展功能的 Markdown 解析器。
• 使用 Jinja2 作为模板语言。Site 使用 tera 模板引擎。
• 非常简单。速度极快。并行构建文章。
• 受 Pelican 启发，Pelican 是一个用 Python 编写的静态网站生成器。Site 具有类似的 文章 和 页面 概念。
• 设计上不灵活且有见地。Site 实现了作者构建简单静态网站所需的功能，如 https://hayatoito.github.io/。如果您想进行自定义，我建议fork Site 本身。Site 故意保持非常小巧，以便您能够轻松理解代码库并进行自定义。

安装

cargo install site

用法

尚无文档。

同时，作为一个活文档，请使用 hayatoito/hayatoito.github.io 作为您的起始模板。 https://hayatoito.github.io/ 是从该仓库构建的。

文件夹结构

root_dir/
 - src/
   - (Put your markdown files here)
 - template/
   - (Put your template files here)

• src/ 是存放所有 Markdown 文件的文件夹。它们使用 Jinja2 模板转换为 HTML 文件，并复制到输出目录。

  src 目录中的任何其他资源也会复制到输出目录。

• template/ 是存放 Jinja2 模板文件的文件夹。

Markdown 格式

Site 使用 Markdown。

# Article title

<!--
date = "2021-12-01"
-->

# Section

Hello Article!

- hello
- world

没有特别之处，除了

• 第一个部分被视为文章的标题。
• 元数据，例如 date，随后。

元数据

待完成：解释

页面

如果 markdown 的元数据包含 page: true，站点 会认为该 markdown 表示一个 页面，而不是一个 文章。

# Page title

<!--
page = true
-->

# Section

Hello Page!

- hello
- world

文章 和 页面 的区别是

• 一个 页面 不会被包含在 articles 模板变量中。也不在 articles_by_year 中。
• 一个 页面 不必包含 date 元数据。

模板变量

待完成：解释

• articles 和 articles_by_year 只在页面中可用。换句话说，一篇文章无法知道其他文章。

entry

除了其元数据外，entry 还包含以下字段

构建

CLI

site build --root-dir . --config=config.toml --out-dir out

root-dir 应包含 src 和 template 文件夹。

有关各种任务的示例 CLI 使用，请参阅 Make.zsh。

GitHub Action

如果您使用 GitHub Pages，还可以使用 GitHub Action 来自动构建和部署。请参阅 build.yml 作为示例。