WebKeys Class
Namespace
Statiq.Web
Base Types
  • object
graph BT Type-->Base0["object"] Type["WebKeys"] class Type type-node

Syntax

public static class WebKeys

Fields

Name Field Type Constant Value Summary
AdditionalFrontMatterRegexes string AdditionalFrontMatterRegexes
Additional regular expressions used to identify front matter.
static
AdditionalSearchableFields string AdditionalSearchableFields
The metadata fields that will be searchable in addition to the default fields of "title", "content", and "tags".
static
AdditionalSearchResultFields string AdditionalSearchResultFields
The metadata fields that will be available in search results in addition to the default fields of "link" and "title".
static
AdditionalXrefPipelines string AdditionalXrefPipelines
The name(s) of additional pipelines to use for xref lookups (defaults to "content", "archives", "assets", "data", "feeds", and "api").
static
ApplyDirectoryMetadata string ApplyDirectoryMetadata
Set to false to prevent processing directory metadata.
static
ArchiveDestination string ArchiveDestination
The destination path of each group output document.
static
ArchiveFilter string ArchiveFilter
An additional metadata filter for documents from the archive pipeline(s) that should return a bool.
static
ArchiveKey string ArchiveKey
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.
static
ArchiveKeyComparer string ArchiveKeyComparer
An IEqualityComparer<object> to use for comparing archive groups.
static
ArchiveOrder string ArchiveOrder
A value that sorting should be based on (I.e. using a computed value).
static
ArchiveOrderDescending string ArchiveOrderDescending
Indicates the archive should be sorted in descending order.
static
ArchiveOrderKey string ArchiveOrderKey
A metadata key that contains the value that sorting should be based on.
static
ArchivePageSize string ArchivePageSize
The number of items on each group page (or all group items if not defined).
static
ArchivePipelines string ArchivePipelines
The pipeline(s) to get documents for the archive from. Defaults to the Content pipeline if not defined.
static
ArchiveSources string ArchiveSources
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).
static
ArchiveTitle string ArchiveTitle
The title of each group output document.
static
Author string Author
The author of the site, post, or page (can be set at any level).
static
AzureAppServicePassword string AzureAppServicePassword
static
AzureAppServiceSiteName string AzureAppServiceSiteName
static
AzureAppServiceUsername string AzureAppServiceUsername
static
CachePath string CachePath
Cache directory path specified as a setting.
static
ClearDataContent string ClearDataContent
Set this to true to clear the content of data files after processing (the default is false).
static
ContentType string ContentType
Indicates the type of content and thus which pipeline will process the file.
static
Copyright string Copyright
static
Description string Description
The description of the document, often used by themes.
static
DirectoryMetadataFiles string DirectoryMetadataFiles
The globbing pattern(s) that will be used to filter directory metadata files.
static
Excluded string Excluded
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.
static
ExcludedPaths string ExcludedPaths
Excluded directory paths specified as a setting.
static
FeedAtom string FeedAtom
static
FeedAuthor string FeedAuthor
static
FeedDescription string FeedDescription
static
FeedFilter string FeedFilter
static
FeedId string FeedId
static
FeedImageLink string FeedImageLink
static
FeedItemAuthor string FeedItemAuthor
static
FeedItemContent string FeedItemContent
static
FeedItemDescription string FeedItemDescription
static
FeedItemId string FeedItemId
static
FeedItemImageLink string FeedItemImageLink
static
FeedItemLink string FeedItemLink
static
FeedItemPublished string FeedItemPublished
static
FeedItemThreadCount string FeedItemThreadCount
static
FeedItemThreadLink string FeedItemThreadLink
static
FeedItemThreadUpdated string FeedItemThreadUpdated
static
FeedItemTitle string FeedItemTitle
static
FeedItemUpdated string FeedItemUpdated
static
FeedLink string FeedLink
static
FeedOrderDescending string FeedOrderDescending
static
FeedOrderKey string FeedOrderKey
static
FeedPipelines string FeedPipelines
static
FeedPublished string FeedPublished
static
FeedRdf string FeedRdf
static
FeedRss string FeedRss
static
FeedSize string FeedSize
static
FeedSources string FeedSources
static
FeedTitle string FeedTitle
static
FeedUpdated string FeedUpdated
static
FrontMatterRegexes string FrontMatterRegexes
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.
static
GatherHeadingsLevel string GatherHeadingsLevel
The level at which to gather headings for a document (this can be set globally or per-document).
static
GenerateSearchIndex string GenerateSearchIndex
Indicates that a client-side Lunr search index file should be generated if true (the default is false).
static
GenerateSitemap string GenerateSitemap
Indicates that a sitemap file should be generated if true (the default).
static
GitHubBranch string GitHubBranch
static
GitHubName string GitHubName
static
GitHubOwner string GitHubOwner
static
GitHubPassword string GitHubPassword
static
GitHubToken string GitHubToken
static
GitHubUsername string GitHubUsername
static
HighlightCode string HighlightCode
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).
static
HighlightUnspecifiedLanguage string HighlightUnspecifiedLanguage
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.
static
IgnoreInvalidXrefs string IgnoreInvalidXrefs
Normally invalid xref targets result in an error. Set this to true to output a warning instead and continue execution.
static
Image string Image
static
IncludeInSitemap string IncludeInSitemap
Set to false to exclude a document from the sitemap file.
static
InputFiles string InputFiles
The globbing pattern(s) used to read input files.
static
InputPaths string InputPaths
Input directory paths specified as settings.
static
Layout string Layout
Indicates the layout file that should be used for this document (used by the Razor template engine).
static
MakeLinksAbsolute string MakeLinksAbsolute
Converts relative links to absolute links.
static
MakeLinksRootRelative string MakeLinksRootRelative
Converts relative links to root-relative links.
static
MediaType string MediaType
Changes the media type of the document (normally this is interpreted from the file extension).
static
MetaRefreshRedirects string MetaRefreshRedirects
Generates META-REFRESH redirect pages (the default value is true).
static
MinimumStatiqWebVersion string MinimumStatiqWebVersion
Sets a semantic version range of Statiq Web that must be used. Particularly useful for themes to set a supported version range.
static
MirrorResources string MirrorResources
static
NetlifyAccessToken string NetlifyAccessToken
static
NetlifyRedirects string NetlifyRedirects
Generates a Netlify redirects file.
static
NetlifySiteId string NetlifySiteId
static
OptimizeContentFileNames string OptimizeContentFileNames
static
OptimizeDataFileNames string OptimizeDataFileNames
static
OutputPath string OutputPath
Output directory path specified as a setting.
static
ProcessSidecarFiles string ProcessSidecarFiles
Set to false to prevent processing sidecar files.
static
Published string Published
The date the file or post was published.
static
PublishedUsesLastModifiedDate string PublishedUsesLastModifiedDate
static
Recursive string Recursive
Used with directory metadata to indicate if the metadata should be applied recursively to files in child directories (the default is true).
static
RemoveScriptExtension string RemoveScriptExtension
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).
static
RenderPostProcessTemplates string RenderPostProcessTemplates
Indicates that post-process templates should be rendered (the default is true).
static
Script string Script
Set to true to indicate that the content contains a script that should be evaluated before processing normally.
static
SearchAllowPositionMetadata string SearchAllowPositionMetadata
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.
static
SearchIncludeHost string SearchIncludeHost
If set to true, the Host will be included in the client-side Lunr search index links.
static
SearchIndexPath string SearchIndexPath
The destination path of the search index file ("search.index.json" or "search.index.json.gz" by default).
static
SearchResultsPath string SearchResultsPath
The destination path of the search results file ("search.results.json" or "search.results.json.gz" by default).
static
SearchScriptPath string SearchScriptPath
The destination path of the client-side Lunr search file ("search.js" by default).
static
SearchStemming string SearchStemming
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.
static
SearchStopWords string SearchStopWords
Specifies stops words to use for the search index. By default a pre-defined set of English stop words are used.
static
SearchStopWordsFilePath string SearchStopWordsFilePath
Specifies an input file that contains stop words to use. The file should contain one stop word per line.
static
ShouldOutput string ShouldOutput
Indicates that the file should be output. By default content and asset files are output and data files are not.
static
TempPath string TempPath
Temp directory path specified as a setting.
static
ThemePaths string ThemePaths
Theme paths specified as settings.
static
Title string Title
The title of the document, often used by themes.
static
Updated string Updated
static
WatchPaths string WatchPaths
Additional paths to watch in preview mode (input paths are always watched).
static
Xref string Xref
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).
static
XrefPipelines string XrefPipelines
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.
static
ZipSearchIndexFile string ZipSearchIndexFile
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.
static
ZipSearchResultsFile string ZipSearchResultsFile
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.
static