Parses, compiles, and renders Handlebars templates.
- Namespace
- Statiq
.Handlebars - Interfaces
- Base Types
-
- object
- Module
- ParallelModule
graph BT
Type-->Base0["ParallelModule"]
click Base0 "/api/Statiq.Common/ParallelModule"
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["RenderHandlebars"]
class Type type-node
Syntax
public class RenderHandlebars : ParallelModule, IModule, IParallelModuleRemarks
Handlebars provides the power necessary to let you build semantic templates effectively with no frustration. See this guide for an introduction to Handlebars.
This module user Handlebars.Net to render Handlebars templates. Handlebars.Net doesn't use a scripting engine to run a Javascript library - it compiles Handlebars templates directly to IL bytecode. It also mimics the JS library's API as closely as possible.
Constructors
| Name | Summary |
|---|---|
| RenderHandlebars |
Parses Handlebars templates in each input document and outputs documents with rendered content. |
| RenderHandlebars |
Parses Handlebars templates in the metadata of each input document and outputs documents with metadata containing the rendered content. |
Properties
| Name | Property Type | Summary |
|---|---|---|
| Parallel | bool |
Indicates whether documents will be
processed by this module in parallel.
Inherited from ParallelModule
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| Configure |
RenderHandlebars |
Specifies an extension point to configure the handlebars environment for each page based on the current input
document and context.
|
| Configure |
RenderHandlebars |
Specifies an extension point to configure the handlebars environment for each page based on the current input
document and context.
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from ParallelModule
|
| ExecuteInputAsync |
Task |
Executes the module.
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| WithBlockHelper |
RenderHandlebars |
Specifies a block helper to be registered for each page based on the current input
document and context.
|
| WithHelper |
RenderHandlebars |
Specifies a helper to be registered for each page based on the current input
document and context.
|
| WithModel |
RenderHandlebars |
Specifies a model to use for each page based on the current input
document and context.
|
| WithPartial |
RenderHandlebars |
Specifies a partial template to be registered for each page based on the current input
document and context.
|