3 个不稳定版本
0.2.0 | 2023年7月10日 |
---|---|
0.1.1 | 2023年2月18日 |
0.1.0 | 2023年2月16日 |
#2287 在 命令行工具
23 每月下载量
16KB
254 行
另一个静态网站生成器
一个非常简单的静态网站生成器,可以将文件编译成纯HTML
特性包括
- 自定义组件
- 编译成纯HTML
- 多页
- 监视文件更改
安装
首先,您需要安装 Rust。然后,通过执行以下命令安装 Yassg
$ cargo install yassg
如果您想从 Git 安装未发布的版本,请克隆此仓库,然后运行 cargo install --path .
入门
项目结构
为您的项目创建一个文件夹。在新 src
目录中,创建一个名为 index.html
的文件和一个名为 components
的文件夹。
文件结构应如下所示
my-project
└── src
├── components
└── index.html
组件和变量
在 components
文件夹内,创建一个名为 Greeting.html
的文件,或您想要的任何名称。它必须以大写字母开头且不包含空格。建议使用 PascalCase。
在这个文件中放入一些 HTML,例如
<div>
<p>Hello, {{name}}!</p>
</div>
{{name}}
是在 HTML 中引用的变量。我们使用组件时给它们赋值。
打开 index.html
,并插入此代码
<!DOCTYPE html>
<html>
<head></head>
<body>
<Greeting name="World" />
</body>
</html>
记得我们在组件目录中给文件起的名称吗?我们使用相同的名称(不带文件扩展名)在 HTML 中使用组件。然后,我们将组件中使用的变量 name
赋值为 World
。
生成网站
添加了一些代码后,我们可以运行 Yassg 来编译它。
$ yassg .
信息
如果您希望 Yassg 在您更改某些内容时自动重新构建项目,请传递--watch
标志
它将读取所有组件文件,并将它们放在 index.html
文件中,带有分配的变量,从而在 dist
目录中生成以下输出
<!DOCTYPE html>
<html>
<head></head>
<body>
<div>
<p>Hello, World!</p>
</div>
</body>
</html>
恭喜您使用 Yassg 制作您的第一个静态页面!
贡献
欢迎在GitHub上提交错误报告和pull请求,链接为:https://github.com/rafal06/yassg。
许可证
Yassg在MIT许可证的条款下作为开源软件提供。
依赖项
~5–14MB
~171K SLoC