Document Metadata

Input Metadata

The metadata values listed below apply to individual documents and are typically set from front matter (with just the name of the key) and used as inputs to the recipes in the pipeline to control behavior.

  • DocsKeys.Author: System.String

    Used by blog posts and pages to indicate the author.

  • DocsKeys.Category: System.String

    Used by blog posts to indicate the category of the post. Also used by pages to indicate the category of the page.

  • DocsKeys.Description: System.String

    Used to provide a description for pages and blog posts that can be used in the meta description tag and also for page listings.

  • DocsKeys.ImplicitInheritDoc: System.Boolean

    Setting this to true will assume inheritdoc for all API symbols that don't provide their own documentation comments.

  • DocsKeys.NoContainer: System.Boolean

    Setting this to true for a document will remove the surrounding container from a page, including the title.

  • DocsKeys.NoGutter: System.Boolean

    Setting this to true will remove the gutter area from around a page.

  • DocsKeys.NoSidebar: System.Boolean

    Setting this to true for a document will remove the sidebar from the page.

  • DocsKeys.NoTitle: System.Boolean

    Setting this to true for a document will remove the title banner from the page.

  • DocsKeys.Order: System.Int32

    Indicates the relative order of pages to each other. If no value is supplied for a document, the default order is 1000 (I.e., after most pages that do have a defined order).

  • DocsKeys.ProcessIncludes: System.Boolean

    Indicates that include statements should be processed using the Wyam.Core.Modules.IO.Include module. The default behavior is to process all includes.

  • DocsKeys.Published: System.DateTime or System.String

    Used for blog posts to store the date of the post.

  • DocsKeys.ShowInNavbar: System.Boolean

    Set to true to hide a particular page from the top-level navigation bar.

  • DocsKeys.Tags: System.String or IEnumerable<string>

    The tags for a given post.

  • DocsKeys.Title: System.String

    The title of the post or page.

Note that these lists aren't exhaustive. Some modules used by the recipe may have their own document metadata that you can set as well.

GitHub