# LINGYUN.Abp.TextTemplating.Scriban
## 模块说明
文本模板 Scriban 引擎模块，提供基于 Scriban 语法的模板渲染实现。
### 基础模块
* Volo.Abp.TextTemplating.Scriban
* LINGYUN.Abp.TextTemplating.Domain
### 功能定义
* 提供 Scriban 模板渲染引擎
* ScribanTemplateRenderingEngine - Scriban 模板渲染引擎实现
* 支持以下功能
* 使用 Scriban 语法编写模板
* 支持模型绑定
* 支持布局模板
* 支持条件语句和循环
* 支持自定义函数和过滤器
* 支持字符串操作和格式化
* 支持数组和对象操作
### 如何使用
1. 添加 `AbpTextTemplatingScribanModule` 依赖
```csharp
[DependsOn(typeof(AbpTextTemplatingScribanModule))]
public class YouProjectModule : AbpModule
{
}
```
2. 创建和使用 Scriban 模板
```csharp
// 创建模板定义
var template = new TextTemplateDefinition(
Guid.NewGuid(),
"Welcome",
"Welcome Email Template",
renderEngine: "Scriban");
// 模板内容示例
Welcome {{ user.name }}!
Thank you for joining us.
{{ if is_first_time }}
Here are some tips to get started...
{{ end }}
{{ for item in items }}
- {{ item.name }}: {{ item.description }}
{{ end }}
// 使用模板
public class YourService
{
private readonly ITemplateRenderer _templateRenderer;
public YourService(ITemplateRenderer templateRenderer)
{
_templateRenderer = templateRenderer;
}
public async Task RenderWelcomeEmailAsync(
string userName,
bool isFirstTime,
List- items)
{
var model = new Dictionary
{
["user"] = new { name = userName },
["is_first_time"] = isFirstTime,
["items"] = items
};
return await _templateRenderer.RenderAsync(
"Welcome",
model
);
}
}
```
[查看英文](README.EN.md)