Lib.rs

构建网页的工具。

我们可以说这个名字是“Caer's Assorted Engineering Resources”（Caer的各种工程资源）的缩写，但我们又在骗谁呢？

入门

首先，安装 Rust。然后运行

cargo install caer

安装完成后，运行 caer 以查看命令列表及其使用方法。

配置

许多命令依赖于配置文件，默认情况下是当前工作目录中的 Config.toml。

如果此文件不存在，将自动创建一个 默认配置，其中包含所有可能的配置选项，以及解释这些选项功能的注释。

工具

使用 site 命令构建静态网站

当调用 site 子命令时，将构建以下类型的文件

• .md 文件被编译为 .html 文件，所有内部链接都是相对于网站根 URL 的规范链接。
• .scss 文件被编译为压缩的 .css 文件。
• .html 文件被编译为压缩的 .html 文件。
• .js 文件被编译为压缩的 .js 文件。
• favicon.png 文件被转换为 favicon.ico 文件。

以 _ 开头的文件和目录将由 其他 文件使用，但不会包含在输出目录中。

所有其他文件将以原样复制到输出目录，不进行编译。

构建文件的模板

所有包含 UTF-8 编码文本的构建文件都可以选择包含 模板指令。这些指令始终以 {> 开头，并以 } 结尾。

例如，给定以下 HTML 文件

<h1>{> name}'s Blog Posts</h1>
{> for post in posts}
<div class="post">
    <h2>{> post.title}</h2>
    <p>{> post.summary}</p>
</div>
{> end}

以及 Config.toml 中的默认上下文，包含以下值

name = "Caer"

[[posts]]
title = "Templating is great."
summary = "Very, very great."

[[posts]]
title = "My First Post!"
summary = "Lorem, Ipsum, Something."

HTML 文件将被构建为

<h1>Caer's Blog Posts</h1>

<div class="post">
    <h2>Templating is great.</h2>
    <p>Very, very great.</p>
</div>

<div class="post">
    <h2>My First Post!</h2>
    <p>Lorem, Ipsum, Something</p>
</div>

要查看可能的模板选项的完整列表，请参阅模板代码。

许可和贡献

版权所有 © 2024 Brandon Sanders。

在GNU Affero通用公共许可证版本3下授权，由自由软件基金会发布。更多信息请参阅许可文件。