DocsKeys Class

Summary

Metadata keys used by the docs recipe.
Assembly
Wyam.Docs.dll
Namespace
Wyam.Docs
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DocsKeys"] class Type type-node

Syntax

public static class DocsKeys

Fields

Name Constant Value Summary
ApiPath ApiPath
Controls the parent path where API docs are placed. The default is "api".
static
AssemblyFiles AssemblyFiles
Indicates where to locate assemblies for the API documentation. You can specify one (or more) globbing pattern(s).
static
Author Author
Used by blog posts and pages to indicate the author.
static
AuthorPageSize AuthorPageSize
The page size for blog author index pages (the default is 5).
static
AutoLinkTypes AutoLinkTypes
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).
static
BaseEditUrl BaseEditUrl
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.
static
BlogAtomPath BlogAtomPath
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.
static
BlogPageSize BlogPageSize
The page size for blog index pages (the default is 5).
static
BlogPath BlogPath
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).
static
BlogRdfPath BlogRdfPath
Specifies the path where the blog RDF file will be output. The default value is null which prevents generating an RDF feed.
static
BlogRssPath BlogRssPath
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.
static
BlogTitle BlogTitle
Specifies the blog title. The default value is Blog.
static
CaseInsensitiveAuthors CaseInsensitiveAuthors
Set to true to make author groupings case-insensitive.
static
CaseInsensitiveCategories CaseInsensitiveCategories
Set to true to make category groupings case-insensitive.
static
CaseInsensitiveTags CaseInsensitiveTags
Set to true to make tag groupings case-insensitive.
static
Category Category
Used by blog posts to indicate the category of the post. Also used by pages to indicate the category of the page.
static
CategoryPageSize CategoryPageSize
The page size for blog category index pages (the default is 5).
static
Description Description
Used to provide a description for pages and blog posts that can be used in the meta description tag and also for page listings.
static
IgnoreFolders IgnoreFolders
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.
static
ImplicitInheritDoc ImplicitInheritDoc
Setting this to true will assume inheritdoc for all API symbols that don't provide their own documentation comments.
static
IncludeDateInPostPath IncludeDateInPostPath
Setting this to true uses the year and date in the output path of blog posts. The default value is false.
static
IncludeGlobalNamespace IncludeGlobalNamespace
Controls whether the global namespace is included in your API documentation.
static
Logo Logo
The path to a logo to use for the site.
static
MarkdownConfiguration MarkdownConfiguration
Set this to control the activated set of Markdown extensions for the Markdig Markdown renderer. The default value is "advanced+bootstrap".
static
MarkdownExtensionTypes MarkdownExtensionTypes
Set this to add extension Markdown extensions for the Markdig Markdown renderer. The default value is null;
static
MarkdownPrependLinkRoot MarkdownPrependLinkRoot
Set to true to prepend a configured LinkRoot to all root-relative Markdown links.
static
MetaRefreshRedirects MetaRefreshRedirects
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).
static
MonthPageSize MonthPageSize
The page size for blog monthly index pages (the default is 5).
static
NetlifyRedirects NetlifyRedirects
Set to true (the default value is false) to generate a Netlify _redirects file from redirected documents (as indicated by a RedirectFrom metadata value).
static
NoContainer NoContainer
Setting this to true for a document will remove the surrounding container from a page, including the title.
static
NoGutter NoGutter
Setting this to true will remove the gutter area from around a page.
static
NoSidebar NoSidebar
Setting this to true for a document will remove the sidebar from the page.
static
NoTitle NoTitle
Setting this to true for a document will remove the title banner from the page.
static
Order Order
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).
static
ProcessIncludes ProcessIncludes
Indicates that include statements should be processed using the Wyam.Core.Modules.IO.Include module. The default behavior is to process all includes.
static
ProjectFiles ProjectFiles
Indicates where to locate project files for the API documentation.
static
Published Published
Used for blog posts to store the date of the post.
static
SearchIndex SearchIndex
Set to false to prevent a search index for API types from being generated and presented on the API pages.
static
ShowInNavbar ShowInNavbar
Set to false to hide a particular page from the top-level navigation bar.
static
ShowInSidebar ShowInSidebar
Set to false to hide a particular page from the side navigation bar.
static
SolutionFiles SolutionFiles
Indicates where to locate solution files for the API documentation.
static
SourceFiles SourceFiles
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.
static
TagPageSize TagPageSize
The page size for blog tag index pages (the default is 5).
static
Tags Tags
The tags for a given post.
static
Title Title
The title of the site, post, or page.
static
ValidateAbsoluteLinks ValidateAbsoluteLinks
Set to true (the default value is false) to validate all absolute links. Note that this may add considerable time to your generation process.
static
ValidateLinksAsError ValidateLinksAsError
Set to true (the default value is false) to report errors on link validation failures.
static
ValidateRelativeLinks ValidateRelativeLinks
Set to true (the default value) to validate all relative links.
static
YearPageSize YearPageSize
The page size for blog yearly index pages (the default is 5).
static
GitHub