IRecipe Interface

Summary

A recipe configures a Wyam.Common.Execution.IEngine in a predefined way using code. Recipes should have an empty default constructor and shouldn't maintain any state.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Configuration
Implementing Types
graph TD Type["IRecipe"] class Type type-node Type-.->Implementing0["Blog"] click Implementing0 "/api/Wyam.Blog/Blog" Type-.->Implementing1["BookSite"] click Implementing1 "/api/Wyam.BookSite/BookSite" Type-.->Implementing2["Recipe"] click Implementing2 "/api/Wyam.Common.Configuration/Recipe" Type-.->Implementing3["Docs"] click Implementing3 "/api/Wyam.Docs/Docs"

Syntax

public interface IRecipe

Methods

Name Value Summary
Apply(IEngine) void
Applies the recipe to the engine.
Scaffold(IFile, IDirectory) void
Scaffolds an example for the recipe in the specified directory.
GitHub