IBootstrapper Interface
Namespace
Statiq.Common
Interfaces
Implementing Types
graph BT Type-.->Interface0["IConfigurable"] click Interface0 "/api/Statiq.Common/IConfigurable" Type["IBootstrapper"] class Type type-node Implementing0["Bootstrapper"]-.->Type click Implementing0 "/api/Statiq.App/Bootstrapper"

Syntax

public interface IBootstrapper : IConfigurable

Properties

Name Property Type Summary
ClassCatalog ClassCatalog
A catalog of all classes in all assemblies loaded by the current application context.
Command IBaseCommand
Gets the command that was run.
Configurators IConfiguratorCollection
A collection of all configurators to be run on the bootstrapper.
FileSystem IFileSystem
Gets the file system that will be passed to the engine.

Methods

Name Return Value Summary
RunAsync() Task<int>
Executes the engine.

Extension Methods

Name Value Summary
AddAnalyzer<IBootstrapper>(IAnalyzer) TBootstrapper
AddAnalyzer<IBootstrapper>(LogLevel, IAnalyzer) TBootstrapper
AddAnalyzer<IBootstrapper>(LogLevel, Type) TBootstrapper
AddAnalyzer<IBootstrapper>(string, IAnalyzer) TBootstrapper
AddAnalyzer<IBootstrapper>(string, LogLevel, IAnalyzer) TBootstrapper
AddAnalyzer<IBootstrapper>(string, Type) TBootstrapper
AddAnalyzer<IBootstrapper>(Type) TBootstrapper
AddAnalyzers<IBootstrapper>(Assembly) TBootstrapper
Adds all analyzers that implement IAnalyzer from the specified assembly.
AddAnalyzers<IBootstrapper>(Type) TBootstrapper
AddAnalyzers<IBootstrapper>() TBootstrapper
Adds all analyzers that implement IAnalyzer from the entry assembly.
AddAssemblyFiles<IBootstrapper>(string[]) TBootstrapper
AddBackgroundNonPreviewProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background and will be started when not in the preview command.
AddBackgroundPreviewProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background and will be started when in the preview command.
AddBackgroundProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background.
AddCommand<IBootstrapper>(Type, string, string) TBootstrapper
AddCommand<IBootstrapper>(Type, string) TBootstrapper
AddCommand<IBootstrapper>(Type) TBootstrapper
AddCommands<IBootstrapper>(Assembly) TBootstrapper
Adds all commands that implement ICommand from the specified assembly.
AddCommands<IBootstrapper>(Type) TBootstrapper
AddCommands<IBootstrapper>() TBootstrapper
Adds all commands that implement ICommand from the entry assembly.
AddConcurrentNonPreviewProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background, will be started when not in the preview command, and will wait for process exit before starting the next process timing phase.
AddConcurrentPreviewProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background, will be started when in the preview command, and will wait for process exit before starting the next process timing phase.
AddConcurrentProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background and will wait for process exit before starting the next process timing phase.
AddDelegateCommand<IBootstrapper>(string, Func<CommandContext, int>) TBootstrapper
AddDelegateCommand<IBootstrapper>(string, string, Func<CommandContext, int>) TBootstrapper
AddDeploymentPipeline<IBootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<IBootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<IBootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<IBootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<IBootstrapper>(string, IEnumerable<string>, IModule[]) TBootstrapper
AddDeploymentPipeline<IBootstrapper>(string, IModule[]) TBootstrapper
AddDocs<IBootstrapper>() TBootstrapper
Adds Statiq Docs functionality to an existing bootstrapper.
AddExcludedPath<IBootstrapper>(NormalizedPath) TBootstrapper
AddHostingCommands<IBootstrapper>() TBootstrapper
Adds the "preview" and "serve" commands (this is called by default when you call CreateWeb(BootstrapperFactory, string[]).
AddInputPath<IBootstrapper>(NormalizedPath) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, IModule[]) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, bool, IModule[]) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<IBootstrapper>(string, string, string, IModule[]) TBootstrapper
AddMappedInputPath<IBootstrapper>(NormalizedPath, NormalizedPath) TBootstrapper
AddNonPreviewProcess<IBootstrapper>(ProcessTiming, bool, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when not in the preview command.
AddNonPreviewProcess<IBootstrapper>(ProcessTiming, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when not in the preview command.
AddNonPreviewProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process and will be started when not in the preview command.
AddPipeline<IBootstrapper>(Func<IReadOnlySettings, IPipeline>) TBootstrapper
AddPipeline<IBootstrapper>(IPipeline) TBootstrapper
AddPipeline<IBootstrapper>(string, Func<IReadOnlySettings, IPipeline>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, bool, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, IEnumerable<string>, string, string, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, IPipeline) TBootstrapper
AddPipeline<IBootstrapper>(string, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, string, bool, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(string, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<IBootstrapper>(string, string, string, IModule[]) TBootstrapper
AddPipeline<IBootstrapper>(Type) TBootstrapper
AddPipelineCommand<IBootstrapper>(string, bool, string[]) TBootstrapper
AddPipelineCommand<IBootstrapper>(string, EngineCommandSettings) TBootstrapper
AddPipelineCommand<IBootstrapper>(string, string, bool, string[]) TBootstrapper
AddPipelineCommand<IBootstrapper>(string, string, EngineCommandSettings) TBootstrapper
AddPipelineCommand<IBootstrapper>(string, string, string[]) TBootstrapper
AddPipelineCommand<IBootstrapper>(string, string[]) TBootstrapper
AddPipelines<IBootstrapper>(Action<IPipelineCollection>) TBootstrapper
AddPipelines<IBootstrapper>(Action<IReadOnlySettings, IPipelineCollection>) TBootstrapper
AddPipelines<IBootstrapper>(Assembly) TBootstrapper
AddPipelines<IBootstrapper>(Type) TBootstrapper
AddPipelines<IBootstrapper>() TBootstrapper
AddPreviewProcess<IBootstrapper>(ProcessTiming, bool, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when in the preview command.
AddPreviewProcess<IBootstrapper>(ProcessTiming, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when in the preview command.
AddPreviewProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that will be started when in the preview command.
AddProcess<IBootstrapper>(ProcessTiming, bool, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process.
AddProcess<IBootstrapper>(ProcessTiming, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process.
AddProcess<IBootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process.
AddProjectFiles<IBootstrapper>(string[]) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, IModule[]) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, bool, IModule[]) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<IBootstrapper>(string, string, string, IModule[]) TBootstrapper
AddSetting<IBootstrapper>(KeyValuePair<string, object>) TBootstrapper
AddSetting<IBootstrapper>(string, object) TBootstrapper
AddSettingIfNonExisting<IBootstrapper>(KeyValuePair<string, object>) TBootstrapper
AddSettingIfNonExisting<IBootstrapper>(string, object) TBootstrapper
AddSettings<IBootstrapper>(IEnumerable<KeyValuePair<string, object>>) TBootstrapper
AddSettingsIfNonExisting<IBootstrapper>(IEnumerable<KeyValuePair<string, object>>) TBootstrapper
AddShortcode<IBootstrapper>(string, Config<ShortcodeResult>) TBootstrapper
AddShortcode<IBootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, IEnumerable<ShortcodeResult>>) TBootstrapper
AddShortcode<IBootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, ShortcodeResult>) TBootstrapper
AddShortcode<IBootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, Task<IEnumerable<ShortcodeResult>>>) TBootstrapper
AddShortcode<IBootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, Task<ShortcodeResult>>) TBootstrapper
AddShortcode<IBootstrapper>(string, Type) TBootstrapper
AddShortcode<IBootstrapper>(Type) TBootstrapper
AddSolutionFiles<IBootstrapper>(string[]) TBootstrapper
AddSourceFiles<IBootstrapper>(string[]) TBootstrapper
AddTemplate<IBootstrapper>(string, ContentType, Phase, IModule) TBootstrapper
Adds a new template.
AddThemePath<IBootstrapper>(NormalizedPath) TBootstrapper
AddWeb<IBootstrapper>() TBootstrapper
Adds Statiq Web functionality to an existing bootstrapper. This method does not need to be called if using CreateWeb(BootstrapperFactory, string[]).
Analyze<IBootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Action<IAnalyzerContext>) TBootstrapper
Analyze<IBootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Func<IAnalyzerContext, Task>) TBootstrapper
Analyze<IBootstrapper>(string, LogLevel, string, Phase, Action<IAnalyzerContext>) TBootstrapper
Analyze<IBootstrapper>(string, LogLevel, string, Phase, Func<IAnalyzerContext, Task>) TBootstrapper
AnalyzeDocument<IBootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Action<IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeDocument<IBootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Func<IDocument, IAnalyzerContext, Task>) TBootstrapper
AnalyzeDocument<IBootstrapper>(string, LogLevel, string, Phase, Action<IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeDocument<IBootstrapper>(string, LogLevel, string, Phase, Func<IDocument, IAnalyzerContext, Task>) TBootstrapper
AnalyzeHtml<IBootstrapper>(string, LogLevel, Action<IHtmlDocument, IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeHtml<IBootstrapper>(string, LogLevel, Func<IHtmlDocument, IDocument, IAnalyzerContext, Task>) TBootstrapper
AnalyzeMarkdown<IBootstrapper>(string, LogLevel, Action<MarkdownDocument, IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeMarkdown<IBootstrapper>(string, LogLevel, Func<MarkdownDocument, IDocument, IAnalyzerContext, Task>) TBootstrapper
BuildConfiguration<IBootstrapper>(Action<IConfigurationBuilder>) TBootstrapper
BuildPipeline<IBootstrapper>(string, Action<PipelineBuilder>) TBootstrapper
ConfigureAnalyzers<IBootstrapper>(Action<IAnalyzerCollection>) TBootstrapper
ConfigureCommands<IBootstrapper>(Action<IConfigurator>) TBootstrapper
ConfigureEngine<IBootstrapper>(Action<IEngine>) TBootstrapper
ConfigureFileSystem<IBootstrapper>(Action<IFileSystem, IReadOnlySettings, IServiceCollection>) TBootstrapper
ConfigureFileSystem<IBootstrapper>(Action<IFileSystem, IReadOnlySettings>) TBootstrapper
ConfigureFileSystem<IBootstrapper>(Action<IFileSystem>) TBootstrapper
ConfigureProcesses<IBootstrapper>(Action<Processes>) TBootstrapper
Configures processes to launch.
ConfigureServices<IBootstrapper>(Action<IServiceCollection, IReadOnlySettings, IReadOnlyFileSystem>) TBootstrapper
ConfigureServices<IBootstrapper>(Action<IServiceCollection, IReadOnlySettings>) TBootstrapper
ConfigureServices<IBootstrapper>(Action<IServiceCollection>) TBootstrapper
ConfigureSettings<IBootstrapper>(Action<ISettings, IServiceCollection, IReadOnlyFileSystem>) TBootstrapper
ConfigureSettings<IBootstrapper>(Action<ISettings, IServiceCollection>) TBootstrapper
ConfigureSettings<IBootstrapper>(Action<ISettings>) TBootstrapper
ConfigureTemplates<IBootstrapper>(Action<Templates>) TBootstrapper
Configures the set of template modules.
ConfigureThemePaths<IBootstrapper>(Action<PathCollection>) TBootstrapper
DeployToAzureAppService<IBootstrapper>(Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPages<IBootstrapper>(Config<string>, Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPages<IBootstrapper>(Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPagesBranch<IBootstrapper>(Config<string>, Config<string>, Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPagesBranch<IBootstrapper>(Config<string>, Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToNetlify<IBootstrapper>(Config<string>, Config<string>) TBootstrapper
ModifyTemplate<IBootstrapper>(string, Func<IModule, IModule>) TBootstrapper
Modifies an existing template.
RemoveTemplate<IBootstrapper>(string) TBootstrapper
Removes the template for a given media type.
RunTestAsync(IFileProvider) Task<BootstrapperTestResult>
Runs tests on the bootstrapper with the specified file system and reports the results.
RunTestAsync(LogLevel, IFileProvider) Task<BootstrapperTestResult>
Runs tests on the bootstrapper with the specified file system and reports the results.
SetDefaultLayoutModule<IBootstrapper>(IModule) TBootstrapper
SetDefaultLayoutTemplate<IBootstrapper>(string) TBootstrapper
SetFailureLogLevel<IBootstrapper>(LogLevel) TBootstrapper
SetOutputPath<IBootstrapper>(NormalizedPath) TBootstrapper
SetRootPath<IBootstrapper>(NormalizedPath) TBootstrapper
SetThemePath<IBootstrapper>(NormalizedPath) TBootstrapper
SubscribeEvent<TEvent>(AsyncEventHandler<TEvent>) IBootstrapper
SubscribeEvent<TEvent>(EventHandler<TEvent>) IBootstrapper
ThrowIfNull<IBootstrapper>(string) T
ToDocument<IBootstrapper>(IContentProvider) IDocument
ToDocument<IBootstrapper>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<IBootstrapper>(NormalizedPath, IContentProvider) IDocument
ToDocument<IBootstrapper>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<IBootstrapper>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<IBootstrapper>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument