Additional regular expressions used to identify front matter.

Additional globbing pattern(s) used to read input files.

The metadata fields that will be searchable in addition to the default fields of "title", "content", and "tags".

The metadata fields that will be available in search results in addition to the default fields of "link" and "title".

The name(s) of additional pipelines to use for xref lookups (defaults to "content", "archives", "assets", "data", "feeds", and "api").

Set to false to prevent processing directory metadata.

The destination path of each group output document.

An additional metadata filter for documents from the archive pipeline(s) that should return a bool.

The key to use for generating archive groups. The source documents will be grouped by the key value(s). This can either be the name of a metadata key to use or a computed value that will get archive key values. If this is not defined, only a single archive index with the source documents will be generated.

An IEqualityComparer<object> to use for comparing archive groups.

A value that sorting should be based on (I.e. using a computed value).

Indicates the archive should be sorted in descending order.

A metadata key that contains the value that sorting should be based on.

The number of items on each group page (or all group items if not defined).

The pipeline(s) to get documents for the archive from. Defaults to the Content pipeline if not defined.

A globbing pattern to filter documents from the archive pipeline(s) based on source path (or all documents from the pipeline(s) if not defined).

The title of each group output document.

The author of the site, post, or page (can be set at any level).

Cache directory path specified as a setting.

Set this to true to clear the content of data files after processing (the default is false).

Indicates the type of content and thus which pipeline will process the file.

The description of the document, often used by themes.

The globbing pattern(s) that will be used to filter directory metadata files.

Indicates the document should be excluded from pipeline processing if true. The default value looks at Published and filters out any future-dated content or data, though you can also define a value for this setting directly for each document.

Excluded directory paths specified as a setting.

The regular expressions used to identify front matter. Change this setting if you want to define entirely new front matter expressions. Otherwise, set AdditionalFrontMatterRegexes if you want to keep the defaults and only want to add new patterns.

The level at which to gather headings for a document (this can be set globally or per-document).

Indicates that a client-side Lunr search index file should be generated if true (the default is false).

Indicates that a sitemap file should be generated if true (the default).

Indicates that generation-time code highlighting should be performed using the highlight.js library (the highlight.js CSS files still need to be included in the site).

Indicates that unspecified languages should be code highlighted. Highlighting unspecified languages is much more tim consuming, so turning this off may improve generation times if a large number of unspecified code blocks are present. No effect if HighlightCode is false. The default is true.

Normally invalid xref targets result in an error. Set this to true to output a warning instead and continue execution.

Set to false to exclude a document from the sitemap file.

The globbing pattern(s) used to read input files.

Input directory paths specified as settings.

Indicates the layout file that should be used for this document (used by the Razor template engine).

Converts relative links to absolute links.

Converts relative links to root-relative links.

Changes the media type of the document (normally this is interpreted from the file extension).

Generates META-REFRESH redirect pages (the default value is true).

Sets a semantic version range of Statiq Web that must be used. Particularly useful for themes to set a supported version range.

Generates redirects in a Netlify redirects file for any file or folder that starts with the prefix specified in NetlifyRedirectPrefix (^ by default) to the same name without them. The default value is true so set this to false to prevent this behavior.

Sets the prefix used when NetlifyPrefixRedirects is true (^ by default).

Generates a Netlify redirects file (or adds to an existing one) for any RedirectFrom and/or RedirectTo metadata. Also ensures a Netlify-style _redirects file is not excluded if one exists in the input folder.

Output directory path specified as a setting.

Set to false to prevent processing sidecar files.

The date the file or post was published.

Used with directory metadata to indicate if the metadata should be applied recursively to files in child directories (the default is true).

Indicates that if a script file has a second extension such as "foo.md.csx" that the script extension should be removed and the preceding extension should be used to reset the media type after script evaluation, and thus the templates that will be executed (the default is true).

Indicates that post-process templates should be rendered (the default is true).

Set to true to indicate that the content contains a script that should be evaluated before processing normally.

Adds the "position" metadata to the metadata allowlist in the search index, which enables position information for each search term in the search results at the expense of index size.

If set to true, the Host will be included in the client-side Lunr search index links.

The destination path of the search index file ("search.index.json" or "search.index.gz" by default).

The destination path of the search results file ("search.results.json" or "search.results.gz" by default).

The destination path of the client-side Lunr search file ("search.js" by default).

Turns on stemming for client-side search. By default an English stemmer is used (you must define your own GenerateLunrIndex module to specify alternate stemming behavior). Turning on stemming also results in the generated client search JavaScript file no longer supporting typeahead searches by default since stemming and wildcard searching don't work well together.

Specifies stops words to use for the search index. By default a pre-defined set of English stop words are used.

Specifies an input file that contains stop words to use. The file should contain one stop word per line.

Additional content types to use in the preview server in the format of "extension=content-type". Can be a single string or an array of strings, one per content type mapping.

Custom headers to use in the preview server in the format of "name=value". Can be a single string or an array of strings, one per custom header.

Indicates that the file should be output. By default content and asset files are output and data files are not.

The description of the site, often used by themes.

The title of the site, often used by themes.

Temp directory path specified as a setting.

Theme paths specified as settings.

The title of the document, often used by themes.

Additional paths to watch in preview mode (input paths are always watched).

Specifies the cross-reference ID of the current document. If not explicitly provided, it will default to the title of the document with spaces replaced by underscores (which is derived from the source file name if no Title metadata is defined for the document).

The name(s) of pipelines to use for xref lookups (defaults to "content", "archives", "assets", "data", "feeds"). Change this setting if you want to define entirely new xref pipelines. Otherwise, set AdditionalXrefPipelines if you want to keep the defaults and only want to add new pipelines.

Indicates whether the search index file should be gzipped (the default is true). If this is true, the JavaScript library pako must be included on the client to decompress the file.

Indicates whether the search results file should be gzipped (the default is true). If this is true, the JavaScript library pako must be included on the client to decompress the file.