1 个不稳定版本
0.1.0 | 2024年6月17日 |
---|
#377 在 模板引擎
21KB
418 行
OreStaty
OreStaty - 以 HTML 为主的基于 handlebars 的静态网站生成器
作为库使用
查看 main.rs 了解如何在 Rust 项目中作为库使用 OreStaty
命令行界面
子命令
- build(默认)标志
- -p/--path - 指定项目路径(默认为当前目录)
- -o/--output - 指定输出目录(默认为 dist)
目录结构
仅“src”目录是必需的。其中的所有文件都将被构建(.html/.htm/.hbs - handlebars,.md/.markdown - markdown + handlebars,.css/.scss/.sass - SASS)。所有“static”目录中的文件都将复制到输出目录。在“plugins”目录中您可以放置
- 用于渲染 HTML 和 Markdown 的 Handlebars 模板
- rhai 辅助脚本用于 Handlebars(参见 percent.rhai 和 page.md;注意:Handlebars 辅助器的范围形式为
example_percent
,不是example.percent
。此外,在 Markdown 中,您可能需要在字符串参数中转义引号)
插件目录中的所有文件/目录都有范围。例如,plugins/theme/template.html 将注册为名称为 theme.template
的 Handlebars 模板。“plugins” 是 SASS 的加载路径(如果您将 bulma-css 放入此目录,则可以导入它,使用 @import bulma/bulma
)。
此目录树示例中展示的所有文件/目录
project_directory
├─src
│ ├─index.html
│ ├─page.md
│ └─global.scss
│
├─static
│ ├─image.png
│ └─robots.txt
│
├─plugins
│ ├─example.rhai
│ └─bulma
│ ├─css
│ ├─sass
│ ├─versions
│ ├─bulma.scss
│ ├─LICENSE
│ ├─package.json
│ └─README.md
│
└─dist (auto generated)
配置
您可以在 config.toml 中配置您的网站。以下是一个展示所有可能配置选项的示例
default_template = "template"
default_markdown_template = "template"
依赖关系
~13–23MB
~355K SLoC