Summary
A utility class that can be used as the base for recipes. It is not necessary to
derive from this class to create a recipe, implementing
Wyam.Common.Configuration.IRecipe is
sufficient. However, this class does provide some helpful functionality such as
using reflection to automatically iterate and add all Wyam.Common.Execution.Pipeline
static properties.
- Assembly
- Wyam
.Common .dll - Namespace
- Wyam
.Common .Configuration - Interfaces
- Base Types
-
- Object
- Derived Types
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IRecipe"]
click Interface0 "/api/Wyam.Common.Configuration/IRecipe"
Type["Recipe"]
class Type type-node
Derived0["Blog"]-->Type
click Derived0 "/api/Wyam.Blog/Blog"
Derived1["Docs"]-->Type
click Derived1 "/api/Wyam.Docs/Docs"
Syntax
public abstract class Recipe : IRecipeMethods
| Name | Value | Summary |
|---|---|---|
| Apply |
void |
This will reflect over all static
Wyam.Common.Execution.Pipeline properties in the
derived class and will add their modules as pipelines to the engine. This operation
depends on Wyam.Common.Util.SourceInfoAttribute having been applied to all the properties
in order to ensure proper ordering.
|
| Scaffold |
void |
Scaffolds an example for the recipe in the specified directory.
|