Settings

The settings listed below apply globally and can be set from the command line or from a configuration file. They are used to configure options and otherwise control the generation process.

In addition to the optional settings listed below, you should also set a host with the following code in your configuration file:

Settings[Keys.Host] = "mysite.com";

While most generated links are relative to ensure local testing works, some links need to be absolute such as feeds. This setting ensures the correct URL is generated for those links.

  • BookSiteKeys.BlogAtomPath: Wyam.Common.IO.FilePath or System.String

    Specifies the path where the blog Atom file will be output. The default value is feed.atom. Set to null to prevent generating an Atom feed.

  • BookSiteKeys.BlogPageSize: System.Int32

    The page size for blog index pages (the default is 5).

  • BookSiteKeys.BlogPath: Wyam.Common.IO.DirectoryPath or System.String

    Controls the parent path where blog posts are placed. The default is "blog". This affects both input and output files (I.e., if you change this your input files must also be under the same path).

  • BookSiteKeys.BlogRdfPath: Wyam.Common.IO.FilePath or System.String

    Specifies the path where the blog RDF file will be output. The default value is null which prevents generating an RDF feed.

  • BookSiteKeys.BlogRssPath: Wyam.Common.IO.FilePath or System.String

    Specifies the path where the blog RSS file will be output. The default value is feed.rss. Set to null to prevent generating an RSS feed.

  • BookSiteKeys.BookImage: System.String

    The path to an image of the book, defaults to "/images/book.png".

  • BookSiteKeys.BookLink: System.String

    A link to the book order form, download, etc.

  • BookSiteKeys.BookLinkText: System.String

    The text to display on book links. Defaults to "Order Now".

  • BookSiteKeys.ChaptersIntro: System.String

    An introduction to display above the chapters listing.

  • BookSiteKeys.ChaptersPath: Wyam.Common.IO.DirectoryPath or System.String

    Controls the parent path where chapters are placed. The default is "chapters". This affects both input and output files (I.e., if you change this your input files must also be under the same path).

  • BookSiteKeys.Description: System.String

    The description of your book (usually placed on the home page).

  • BookSiteKeys.IgnoreFolders: System.String or IEnumerable<string>

    This should be a string or array of strings with the name(s) of root-level folders to ignore when scanning for content pages. Setting this global metadata value is useful when introducing your own pipelines for files under certain folders and you don't want the primary content page pipelines to pick them up.

  • BookSiteKeys.Image: System.String

    The relative path to an image to display in the layout.

  • BookSiteKeys.IncludeDateInPostPath: System.Boolean

    Setting this to true uses the year and date in the output path of blog posts. The default value is false.

  • BookSiteKeys.MarkdownConfiguration: System.String

    Set this to control the activated set of Markdown extensions for the Markdig Markdown renderer. The default value is "advanced+bootstrap".

  • BookSiteKeys.MarkdownExtensionTypes: System.Collections.Generic.IEnumerable`1

    Set this to add extension Markdown extensions for the Markdig Markdown renderer. The default value is null;

  • BookSiteKeys.MetaRefreshRedirects: System.Boolean

    Set to true (the default value) to generate meta refresh pages for any redirected documents (as indicated by a RedirectFrom metadata value in the document).

  • BookSiteKeys.NetlifyRedirects: System.Boolean

    Set to true (the default value is false) to generate a Netlify _redirects file from redirected documents (as indicated by a RedirectFrom metadata value).

  • BookSiteKeys.ProcessIncludes: System.Boolean

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

  • BookSiteKeys.SectionsPath: Wyam.Common.IO.DirectoryPath or System.String

    Controls the parent path where sections for the homepage are placed. The default is "sections".

  • BookSiteKeys.Subtitle: System.String

    The subtitle of the book.

  • BookSiteKeys.Title: System.String

    The title of the book.

  • BookSiteKeys.ValidateAbsoluteLinks: System.Boolean

    Set to true (the default value is false) to validate all absolute links. Note that this may add considerable time to your generation process.

  • BookSiteKeys.ValidateLinksAsError: System.Boolean

    Set to true (the default value is false) to report errors on link validation failures.

  • BookSiteKeys.ValidateRelativeLinks: System.Boolean

    Set to true (the default value) to validate all relative links.

Note that this list isn't exhaustive. Some modules used by the recipe may have their own settings that you can set as well. General settings are also available to every recipe.

GitHub