Summary
A recipe for creating documentation websites.
- Assembly
- Wyam
.Docs .dll - Namespace
- Wyam
.Docs - Interfaces
- Base Types
-
- Object
- Recipe
graph BT
Type-->Base0["Recipe"]
click Base0 "/api/Wyam.Common.Configuration/Recipe"
Base0-->Base1["Object"]
Type-.->Interface0["IRecipe"]
click Interface0 "/api/Wyam.Common.Configuration/IRecipe"
Type["Docs"]
class Type type-node
Syntax
public class Docs : Recipe, IRecipeProperties
| Name | Value | Summary |
|---|---|---|
| Api | Api |
static
|
| ApiIndex | ApiIndex |
static
|
| ApiSearchIndex | ApiSearchIndex |
static
|
| BlogArchives | Archive |
Generates the monthly archive pages for blog posts.
static
|
| BlogAuthors | Archive |
Generates the author pages for blog posts.
static
|
| BlogCategories | Archive |
Generates the category pages for blog posts.
static
|
| BlogFeed | Web |
static
|
| BlogIndexes | Archive |
Generates the index pages for blog posts.
static
|
| BlogPosts | BlogPosts |
static
|
| BlogTags | Archive |
Generates the tag pages for blog posts.
static
|
| BlogYearlyArchives | Archive |
Generates the yearly archive pages for blog posts.
static
|
| Code | Code |
static
|
| Less | Web |
static
|
| Pages | Pages |
static
|
| Redirects | Redirects |
static
|
| RenderApi | RenderApi |
static
|
| RenderBlogPosts | RenderBlogPosts |
static
|
| RenderPages | RenderPages |
static
|
| Resources | Resources |
static
|
| Sass | Web |
static
|
| ValidateLinks | Web |
static
|
Methods
| 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.
|