The primary module interface for classes that can transform or otherwise operate on documents.
- Namespace
- Statiq
.Common - Implementing Types
-
- RenderScriban
- ReadSql
- DeploySearchIndex
- CompileLess
- ProcessScripts
- ReadSolution
- SyncModule
- MinifyJs
- CopyMetadata
- InsertLinks
- MultiConfigModule
- Render
Content Post Process Templates - RenderRazor
- EvaluateScript
- TakeDocuments
- ReplaceWithContent
- ReadXmp
- ProcessHtml
- CreateDocuments
- GenerateExcerpt
- ParseYaml
- ExecuteIf
- ExecutionPipeline
- SetContentType
- RenderMarkdown
- FilterDocuments
- CombineDocuments
- ThrowException
- SyncConfigModule
<TValue> - CountModule
- ConfigModule
<TValue> - ExecuteConfig
- CacheDocuments
- CompileSass
- DeployNetlifySite
- EnumerateValues
- SetMediaType
- MergeMetadata
- Parallel
Sync Config Module <TValue> - ExecuteModules
- ReadProject
- ParallelSyncModule
- ReadDataModule
<TModule, TItem> - ExecuteSwitch
- DeployAppService
- SetMetadata
- MinifyCss
- ProcessSidecarFile
- MirrorResources
- ResolveXrefs
- OptimizeFileName
- FilterDestinations
- ExecuteDestinations
- ParseJson
- Parallel
Sync Multi Config Module - AddRtlSupport
- AddContentToMetadata
- SetDestination
- ThrowExceptionIf
- ParentModule
- Make
Links Root Relative - ExtractFrontMatter
- ReadApi
<TClient> - RenderCsvAsMarkdown
- Multi
Config Module Base - MinifyXml
- WriteFiles
- PaginateDocuments
- LogMessage
- AddTitle
- DeployGitHubPages
- OrderDocuments
- ForEachDocument
- ReadCsv
- Sync
Multi Config Module - EscapeHtml
- FlattenTree
- ReadXml
- AppendContent
- ConcatDocuments
- GenerateJson
- MergeContent
- ZipDirectory
- HighlightCode
- InsertHtml
- TransformXslt
- MinifyXhtml
- GenerateSitemap
- CopyFiles
- MutateImage
- GenerateFeeds
- ConvertExcelToCsv
- StartProcess
- ReadYouTube
- Remove
Tree Placeholders - RetryModules
- AddIndexes
- SyncParentModule
- PrependContent
- ProcessShortcodes
- ReadFiles
- ParallelModule
- QueryHtml
- JoinDocuments
- ReplaceInContent
- Module
- SetContent
- GroupDocuments
- Render
Content Process Templates - ParallelConfigModule
<TValue> - Add
Documents To Metadata - ClearDocuments
- FilterSources
- MakeLinksAbsolute
- ReadApplicationInput
- GatherHeadings
- RenderHandlebars
- Sync
Child Documents Module - Parallel
Multi Config Module - ExecuteBranch
- ReadWeb
- ReplaceDocuments
- ValidateMetadata
<T> - MergeDocuments
- MinifyHtml
- GenerateRedirects
- ReadGitHub
- GenerateLunrIndex
- ChildDocumentsModule
- ExecuteSources
- GatherDocuments
- AnalyzeCSharp
- ReadWorkspace
- GetPipelineDocuments
- Generate
Cloud Search Data - ReadExcel
- Apply
Directory Metadata - RenderCsvAsHtml
- CreateTree
- ForAllDocuments
Syntax
public interface IModuleRemarks
If the module implements
IDisposable, System.IDisposable.Dispose
will be called when the engine is disposed (I.e., on application exit).
Methods
| Name | Return Value | Summary |
|---|---|---|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
|