| AddContentToMetadata |
Adds the result document(s) content to metadata of the input documents.
|
| AddDocumentsToMetadata |
Adds the result document(s) to metadata of the input documents.
|
| AddIndexes |
Adds a one-based index to every document as metadata.
|
| AddRtlSupport |
|
| AddTitle |
Sets a title metadata key for documents based on their file path or source.
|
| AppendContent |
Appends the specified content to the existing content of each document.
|
| ArgumentSplitter |
Splits a string into quoted arguments delimited by spaces.
|
| CacheDocuments |
Caches documents between executions.
|
| ClearDocuments |
Clears all input documents and outputs an empty document collection.
|
| CombineDocuments |
Combines all of the input documents into a single output document.
|
| ConcatDocuments |
Concatenates documents in the current pipeline.
|
| CopyFiles |
Copies the content of files from one path on to another path.
|
| CopyMetadata |
Copies the specified meta key to a new meta key, with an optional format argument.
|
| CreateDocuments |
Creates new documents.
|
| CreateTree |
Adds metadata to the input documents that describes the position of each one in a tree structure.
|
| Engine |
The engine is the primary entry point for the generation process.
|
| EnumerateValues |
Clones a new document for each item in a given metadata value.
|
| EscapeHtml |
Automatically escapes HTML content.
|
| EvalShortcode |
Evaluates C# code.
|
| EvaluateScript |
Evaluates a C# based script contained in document content.
|
| ExecuteBranch |
Executes "branches" of modules with the input documents and concatenates their outputs.
|
| ExecuteConfig |
Gets documents from an arbitrary config value.
|
| ExecuteDestinations |
|
| ExecuteIf |
Evaluates a series of child modules for each input document if a specified condition is met.
|
| ExecuteModules |
Executes modules and outputs the original input documents.
|
| ExecuteSources |
|
| ExecuteSwitch |
Executes sequences of modules depending on whether the input document contains a specified value.
|
| ExecutionPipeline |
A base pipeline that runs code for each execution phase.
|
| ExtractFrontMatter |
Extracts the first part of content for each document and sends it to a child module for processing.
|
| FileCleaner |
|
| FileSystem |
|
| FilterDestinations |
Filters the current sequence of documents by destination.
|
| FilterDocuments |
Filters the current sequence of documents using a predicate.
|
| FilterSources |
Filters the current sequence of documents by source.
|
| FlattenTree |
Flattens a tree structure.
|
| ForEachShortcode |
Iterates a sequence from metadata, setting a specified key for each iteration.
|
| GatherHeadings |
Queries HTML content of the input documents and adds a metadata value that contains it's headings.
|
| GenerateExcerpt |
Finds the first occurrence of a specified HTML comment or element and stores it's contents as metadata.
|
| GenerateJson |
Converts objects stored in metadata or elsewhere to JSON.
|
| GenerateRedirects |
Handles redirected content by creating pages with meta refresh tags or other redirect files.
|
| GenerateSitemap |
Generates a site map from the input documents.
|
| GroupDocuments |
Splits a sequence of documents into groups based on a specified function or metadata key
that returns or contains a sequence of group keys.
|
| HttpClientExtensions |
|
| IEngineExtensions |
|
| IfCondition |
|
| IfShortcode |
Renders the shortcode content if the specified key equals a given value (or is true).
|
| IncludeShortcode |
Includes a file from the virtual file system.
|
| InsertHtml |
Queries HTML content of the input documents and inserts new content into the elements that
match a query selector.
|
| InsertLinks |
Replaces occurrences of specified strings with HTML links.
|
| IPipelineExtensions |
|
| JoinDocuments |
Joins documents together with an optional delimiter to form one document.
|
| LocalFileProvider |
|
| LogLevelFailureException |
|
| LogMessage |
Outputs log messages during execution.
|
| MakeLinksAbsolute |
Converts all relative links to absolute using the "Host" and other settings values.
|
| MakeLinksRootRelative |
Converts all relative links to root-relative using the destination path of the containing document.
|
| MemoryStreamFactory |
Forwards calls to an underlying RecyclableMemoryStreamManager
so that Statiq.Common doesn't have to maintain a reference to it.
|
| MergeContent |
Clones each input document with the content from each result document.
|
| MergeDocuments |
Clones each input document with the content and metadata from each result document.
|
| MergeMetadata |
Clones each input document with the metadata from each result document.
|
| MetaShortcode |
Renders the metadata value with the given key from the current document.
|
| MirrorResources |
Mirrors external link and script resources locally.
|
| NamespaceCollection |
|
| OptimizeFileName |
Optimizes a file name.
|
| OrderDocuments |
Orders the input documents based on the specified key function.
|
| PaginateDocuments |
Splits a sequence of documents into multiple pages.
|
| ParseJson |
|
| Pipeline |
A base pipeline class.
|
| PipelineException |
The exception that is thrown when a pipeline is misconfigured or invalid.
|
| PrependContent |
Prepends the specified content to the existing content of each document.
|
| ProcessHtml |
Queries HTML content of the input documents and modifies the elements that
match a query selector.
|
| ProcessShortcodes |
Renders shortcodes in the input documents.
|
| ProcessSidecarFile |
Extracts the content of a Sidecar file for each document and sends it to a child module for processing.
|
| QueryHtml |
Queries HTML content of the input documents and creates new documents with content and metadata from the results.
|
| RawShortcode |
A special shortcode that will output whatever is in it's content.
|
| ReadApi<TClient> |
Outputs metadata for information from any API with its client.
|
| ReadApplicationInput |
Reads text provided to the application on startup.
|
| ReadFiles |
Reads the content of files from the file system into the content of new documents.
|
| ReadSql |
Creates documents from the results of a SQL query. Each row is output
as a new document and every column is used as the metadata (or content) of
the new document. Input documents are ignored.
|
| ReadWeb |
Downloads from HTTP and outputs the results as new documents.
|
| ReadXml |
Creates new documents from elements within XML. This module will either
ignore input documents and use specified XML content or use the content
from input documents depending on how it's configured. An XPath expression
can be used to find target XML elements, and the InnerXml of each child element
of the target elements as well as the values of each attribute
will be placed into the metadata of the generated documents.
|
| ReflectionHelper |
|
| RemoveTreePlaceholders |
Removes tree placeholder documents (this module will not flatten a tree).
|
| ReplaceDocuments |
Replaces documents in the current pipeline.
|
| ReplaceInContent |
Replaces a search string in the content of each input document with new content.
|
| ReplaceWithContent |
Replaces a search string in the specified content with the content of input documents.
|
| RetryModules |
|
| ScriptBase |
|
| ScriptCompilationException |
|
| ScriptFactoryBase |
|
| ScriptHelper |
|
| SetContent |
Sets the content of each document.
|
| SetDestination |
Sets the document destination.
|
| SetMediaType |
Sets the media type of each document.
|
| SetMetadata |
Sets the specified metadata in each input document.
|
| SitemapItem |
Represents an item in the site map.
|
| StartProcess |
Starts a system process.
|
| StartProcessArgument |
|
| TakeDocuments |
Takes the first X documents from the current pipeline and discards the rest.
|
| ThrowException |
Throws an exception.
|
| ThrowExceptionIf |
Throws an exception if a condition is true.
|
| TransformXslt |
Transforms input documents using a supplied XSLT template.
|
| ValidateMetadata<T> |
Tests metadata for existence, typing, and supplied assertions.
|
| WebRequest |
A download request for use with the ReadWeb module.
|
| WebRequestHeaders |
The request headers to use with the ReadWeb module.
|
| WriteFiles |
Writes the content of each input document to the file system.
|
| ZipDirectory |
Zips the contents of a given directory.
|