# LINGYUN.Abp.TextTemplating.Scriban
## Module Description
Text templating Scriban engine module, providing template rendering implementation based on Scriban syntax.
### Base Modules
* Volo.Abp.TextTemplating.Scriban
* LINGYUN.Abp.TextTemplating.Domain
### Features
* Provides Scriban template rendering engine
* ScribanTemplateRenderingEngine - Scriban template rendering engine implementation
* Supports the following features
* Write templates using Scriban syntax
* Support model binding
* Support layout templates
* Support conditional statements and loops
* Support custom functions and filters
* Support string operations and formatting
* Support array and object operations
### How to Use
1. Add `AbpTextTemplatingScribanModule` dependency
```csharp
[DependsOn(typeof(AbpTextTemplatingScribanModule))]
public class YouProjectModule : AbpModule
{
}
```
2. Create and use Scriban templates
```csharp
// Create template definition
var template = new TextTemplateDefinition(
Guid.NewGuid(),
"Welcome",
"Welcome Email Template",
renderEngine: "Scriban");
// Template content example
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 }}
// Use template
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.md)