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.

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

    Indicates where to locate assemblies for the API documentation. You can specify one (or more) globbing pattern(s).

  • DocsKeys.AuthorPageSize: System.Int32

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

  • DocsKeys.AutoLinkTypes: System.Boolean

    Controls whether type names from the API enclosed in code fences in either blog posts or content pages should be automatically linked to the corresponding API documentation page (the default is true).

  • DocsKeys.BaseEditUrl: System.String

    The base URL for generating edit links for content and blog pages. The edit link combines this base URL with the relative path of the input file.

  • DocsKeys.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.

  • DocsKeys.BlogPageSize: System.Int32

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

  • DocsKeys.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).

  • DocsKeys.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.

  • DocsKeys.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.

  • DocsKeys.CaseInsensitiveAuthors: System.Boolean

    Set to true to make author groupings case-insensitive.

  • DocsKeys.CaseInsensitiveCategories: System.Boolean

    Set to true to make category groupings case-insensitive.

  • DocsKeys.CaseInsensitiveTags: System.Boolean

    Set to true to make tag groupings case-insensitive.

  • DocsKeys.CategoryPageSize: System.Int32

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

  • DocsKeys.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.

  • DocsKeys.IncludeDateInPostPath: System.Boolean

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

  • DocsKeys.IncludeGlobalNamespace: System.Boolean

    Controls whether the global namespace is included in your API documentation.

  • DocsKeys.Logo: Wyam.Common.IO.FilePath

    The path to a logo to use for the site.

  • DocsKeys.MarkdownConfiguration: System.String

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

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

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

  • DocsKeys.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).

  • DocsKeys.MonthPageSize: System.Int32

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

  • DocsKeys.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).

  • 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.ProjectFiles: System.String or IEnumerable<string>

    Indicates where to locate project files for the API documentation.

  • DocsKeys.SearchIndex: System.Boolean

    Set to false to prevent a search index for API types from being generated and presented on the API pages.

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

    Indicates where to locate solution files for the API documentation.

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

    Indicates where to locate source files for the API documentation. By default the globbing pattern "src/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs" is used which searches for all "*.cs" files at any depth under a "src" folder but not under "bin", "obj", "packages" or "Tests" folders. You can specify your own globbing pattern (or more than one globbing pattern) if your source files are found elsewhere.

  • DocsKeys.TagPageSize: System.Int32

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

  • DocsKeys.Title: System.String

    The title of the site.

  • DocsKeys.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.

  • DocsKeys.ValidateLinksAsError: System.Boolean

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

  • DocsKeys.ValidateRelativeLinks: System.Boolean

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

  • DocsKeys.YearPageSize: System.Int32

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

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