Recipe Class

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 TD Base0["object"]-->Type Interface0["IRecipe"]-.->Type click Interface0 "/api/Wyam.Common.Configuration/IRecipe" Type["Recipe"] class Type type-node Type-->Derived0["Docs"] click Derived0 "/api/Wyam.Docs/Docs" Type-->Derived1["BookSite"] click Derived1 "/api/Wyam.BookSite/BookSite" Type-->Derived2["Blog"] click Derived2 "/api/Wyam.Blog/Blog"

Syntax

public abstract class Recipe : IRecipe

Methods

Name Value Summary
Apply(IEngine) 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(IFile, IDirectory) void
Scaffolds an example for the recipe in the specified directory.
GitHub