Bootstrapper Class
Namespace
Statiq.App
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IBootstrapper"] click Interface0 "/api/Statiq.Common/IBootstrapper" Type-.->Interface1["IConfigurable"] click Interface1 "/api/Statiq.Common/IConfigurable" Type["Bootstrapper"] class Type type-node

Syntax

public class Bootstrapper : IBootstrapper, IConfigurable

Fields

Name Field Type Constant Value Summary
Factory BootstrapperFactory
static

Properties

Name Property Type Summary
Arguments string[]
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
CreateServiceCollection() IServiceCollection
Creates a service collection for use by the bootstrapper.
RunAsync() Task<int>
Executes the engine.
SetDefaultCommand<TCommand>() Bootstrapper

Extension Methods

Name Value Summary
AddAnalyzer<TAnalyzer>() Bootstrapper
AddAnalyzer<TAnalyzer>(LogLevel) Bootstrapper
AddAnalyzer<TAnalyzer>(string) Bootstrapper
AddAnalyzer<TAnalyzer>(string, LogLevel) Bootstrapper
AddAnalyzer<Bootstrapper>(IAnalyzer) TBootstrapper
AddAnalyzer<Bootstrapper>(LogLevel, IAnalyzer) TBootstrapper
AddAnalyzer<Bootstrapper>(LogLevel, Type) TBootstrapper
AddAnalyzer<Bootstrapper>(string, IAnalyzer) TBootstrapper
AddAnalyzer<Bootstrapper>(string, LogLevel, IAnalyzer) TBootstrapper
AddAnalyzer<Bootstrapper>(string, Type) TBootstrapper
AddAnalyzer<Bootstrapper>(Type) TBootstrapper
AddAnalyzers<Bootstrapper>() TBootstrapper
Adds all analyzers that implement IAnalyzer from the entry assembly.
AddAnalyzers<Bootstrapper>(Assembly) TBootstrapper
Adds all analyzers that implement IAnalyzer from the specified assembly.
AddAnalyzers<Bootstrapper>(Type) TBootstrapper
AddAnalyzers<TParent>() Bootstrapper
AddAssemblyFiles<Bootstrapper>(string[]) TBootstrapper
AddBackgroundNonPreviewProcess<Bootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background and will be started when not in the preview command.
AddBackgroundPreviewProcess<Bootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background and will be started when in the preview command.
AddBackgroundProcess<Bootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that runs in the background.
AddBootstrapperConfigurators() Bootstrapper
AddBuildCommands() Bootstrapper
AddCommand<Bootstrapper>(Type) TBootstrapper
AddCommand<Bootstrapper>(Type, string) TBootstrapper
AddCommand<Bootstrapper>(Type, string, string) TBootstrapper
AddCommand<TCommand>() Bootstrapper
AddCommand<TCommand>(string) Bootstrapper
AddCommands<Bootstrapper>() TBootstrapper
Adds all commands that implement ICommand from the entry assembly.
AddCommands<Bootstrapper>(Assembly) TBootstrapper
Adds all commands that implement ICommand from the specified assembly.
AddCommands<Bootstrapper>(Type) TBootstrapper
AddCommands<TParent>() Bootstrapper
AddConcurrentNonPreviewProcess<Bootstrapper>(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<Bootstrapper>(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<Bootstrapper>(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.
AddConfigurator<TConfigurable, TConfigurator>() Bootstrapper
AddConfigurator<TConfigurable>(IConfigurator<TConfigurable>) Bootstrapper
AddCustomCommands() Bootstrapper
AddDefaultConfigurationFiles() Bootstrapper
AddDefaultLogging() Bootstrapper
AddDefaultNamespaces() Bootstrapper
AddDefaultPipelines() Bootstrapper
AddDefaults(DefaultFeatures) Bootstrapper
AddDefaultSettings() Bootstrapper
AddDefaultShortcodes() Bootstrapper
AddDefaultsWithout(DefaultFeatures) Bootstrapper
AddDelegateCommand<Bootstrapper>(string, Func<CommandContext, int>) TBootstrapper
AddDelegateCommand<Bootstrapper>(string, string, Func<CommandContext, int>) TBootstrapper
AddDelegateCommand<TSettings>(string, Func<CommandContext, TSettings, int>) Bootstrapper
AddDelegateCommand<TSettings>(string, string, Func<CommandContext, TSettings, int>) Bootstrapper
AddDeploymentPipeline<Bootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<Bootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<Bootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<Bootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddDeploymentPipeline<Bootstrapper>(string, IEnumerable<string>, IModule[]) TBootstrapper
AddDeploymentPipeline<Bootstrapper>(string, IModule[]) TBootstrapper
AddDocs<Bootstrapper>() TBootstrapper
Adds Statiq Docs functionality to an existing bootstrapper.
AddEnvironmentVariables() Bootstrapper
AddExcludedPath<Bootstrapper>(NormalizedPath) TBootstrapper
AddGlobCommands() Bootstrapper
AddHostingCommands<Bootstrapper>() TBootstrapper
Adds the "preview" and "serve" commands (this is called by default when you call CreateWeb(BootstrapperFactory, string[]).
AddInputPath<Bootstrapper>(NormalizedPath) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, IModule[]) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, bool, IModule[]) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddIsolatedPipeline<Bootstrapper>(string, string, string, IModule[]) TBootstrapper
AddMappedInputPath<Bootstrapper>(NormalizedPath, NormalizedPath) TBootstrapper
AddNonPreviewProcess<Bootstrapper>(ProcessTiming, bool, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when not in the preview command.
AddNonPreviewProcess<Bootstrapper>(ProcessTiming, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when not in the preview command.
AddNonPreviewProcess<Bootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process and will be started when not in the preview command.
AddPipeline<Bootstrapper>(Func<IReadOnlySettings, IPipeline>) TBootstrapper
AddPipeline<Bootstrapper>(IPipeline) TBootstrapper
AddPipeline<Bootstrapper>(string, Func<IReadOnlySettings, IPipeline>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, bool, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, IEnumerable<string>, string, string, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, IPipeline) TBootstrapper
AddPipeline<Bootstrapper>(string, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, string, bool, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(string, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddPipeline<Bootstrapper>(string, string, string, IModule[]) TBootstrapper
AddPipeline<Bootstrapper>(Type) TBootstrapper
AddPipeline<TPipeline>() Bootstrapper
Registers a pipeline of type TPipeline.
AddPipeline<TPipeline>(string) Bootstrapper
Registers a pipeline of type TPipeline with the specified name.
AddPipelineCommand<Bootstrapper>(string, bool, string[]) TBootstrapper
AddPipelineCommand<Bootstrapper>(string, EngineCommandSettings) TBootstrapper
AddPipelineCommand<Bootstrapper>(string, string, bool, string[]) TBootstrapper
AddPipelineCommand<Bootstrapper>(string, string, EngineCommandSettings) TBootstrapper
AddPipelineCommand<Bootstrapper>(string, string, string[]) TBootstrapper
AddPipelineCommand<Bootstrapper>(string, string[]) TBootstrapper
AddPipelines<Bootstrapper>() TBootstrapper
AddPipelines<Bootstrapper>(Action<IPipelineCollection>) TBootstrapper
AddPipelines<Bootstrapper>(Action<IReadOnlySettings, IPipelineCollection>) TBootstrapper
AddPipelines<Bootstrapper>(Assembly) TBootstrapper
AddPipelines<Bootstrapper>(Type) TBootstrapper
AddPipelines<TParent>() Bootstrapper
Registers all pipelines defined in TParent.
AddPreviewProcess<Bootstrapper>(ProcessTiming, bool, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when in the preview command.
AddPreviewProcess<Bootstrapper>(ProcessTiming, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process that will be started when in the preview command.
AddPreviewProcess<Bootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process that will be started when in the preview command.
AddProcess<Bootstrapper>(ProcessTiming, bool, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process.
AddProcess<Bootstrapper>(ProcessTiming, Func<IExecutionState, ProcessLauncher>) TBootstrapper
Adds a new process.
AddProcess<Bootstrapper>(ProcessTiming, string, string[]) TBootstrapper
Adds a new process.
AddProjectFiles<Bootstrapper>(string[]) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, IModule[]) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, bool, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, bool, IModule[]) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, Config<NormalizedPath>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, Config<NormalizedPath>, IModule[]) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, IEnumerable<IModule>, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, string, IEnumerable<IModule>, IEnumerable<IModule>) TBootstrapper
AddSerialPipeline<Bootstrapper>(string, string, string, IModule[]) TBootstrapper
AddSetting<Bootstrapper>(KeyValuePair<string, object>) TBootstrapper
AddSetting<Bootstrapper>(string, object) TBootstrapper
AddSettingIfNonExisting<Bootstrapper>(KeyValuePair<string, object>) TBootstrapper
AddSettingIfNonExisting<Bootstrapper>(string, object) TBootstrapper
AddSettings<Bootstrapper>(IEnumerable<KeyValuePair<string, object>>) TBootstrapper
AddSettingsIfNonExisting<Bootstrapper>(IEnumerable<KeyValuePair<string, object>>) TBootstrapper
AddShortcode<Bootstrapper>(string, Config<ShortcodeResult>) TBootstrapper
AddShortcode<Bootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, IEnumerable<ShortcodeResult>>) TBootstrapper
AddShortcode<Bootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, ShortcodeResult>) TBootstrapper
AddShortcode<Bootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, Task<IEnumerable<ShortcodeResult>>>) TBootstrapper
AddShortcode<Bootstrapper>(string, Func<KeyValuePair<string, string>[], string, IDocument, IExecutionContext, Task<ShortcodeResult>>) TBootstrapper
AddShortcode<Bootstrapper>(string, Type) TBootstrapper
AddShortcode<Bootstrapper>(Type) TBootstrapper
AddShortcode<TShortcode>() Bootstrapper
AddShortcode<TShortcode>(string) Bootstrapper
AddSolutionFiles<Bootstrapper>(string[]) TBootstrapper
AddSourceFiles<Bootstrapper>(string[]) TBootstrapper
AddTemplate<Bootstrapper>(string, ContentType, Phase, IModule) TBootstrapper
Adds a new template.
AddThemePath<Bootstrapper>(NormalizedPath) TBootstrapper
AddWeb<Bootstrapper>() TBootstrapper
Adds Statiq Web functionality to an existing bootstrapper. This method does not need to be called if using CreateWeb(BootstrapperFactory, string[]).
Analyze<Bootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Action<IAnalyzerContext>) TBootstrapper
Analyze<Bootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Func<IAnalyzerContext, Task>) TBootstrapper
Analyze<Bootstrapper>(string, LogLevel, string, Phase, Action<IAnalyzerContext>) TBootstrapper
Analyze<Bootstrapper>(string, LogLevel, string, Phase, Func<IAnalyzerContext, Task>) TBootstrapper
AnalyzeDocument<Bootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Action<IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeDocument<Bootstrapper>(string, LogLevel, IEnumerable<KeyValuePair<string, Phase>>, Func<IDocument, IAnalyzerContext, Task>) TBootstrapper
AnalyzeDocument<Bootstrapper>(string, LogLevel, string, Phase, Action<IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeDocument<Bootstrapper>(string, LogLevel, string, Phase, Func<IDocument, IAnalyzerContext, Task>) TBootstrapper
AnalyzeHtml<Bootstrapper>(string, LogLevel, Action<IHtmlDocument, IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeHtml<Bootstrapper>(string, LogLevel, Func<IHtmlDocument, IDocument, IAnalyzerContext, Task>) TBootstrapper
AnalyzeMarkdown<Bootstrapper>(string, LogLevel, Action<MarkdownDocument, IDocument, IAnalyzerContext>) TBootstrapper
AnalyzeMarkdown<Bootstrapper>(string, LogLevel, Func<MarkdownDocument, IDocument, IAnalyzerContext, Task>) TBootstrapper
BuildConfiguration<Bootstrapper>(Action<IConfigurationBuilder>) TBootstrapper
BuildPipeline<Bootstrapper>(string, Action<PipelineBuilder>) TBootstrapper
Configure<TConfigurable>(Action<TConfigurable>) Bootstrapper
ConfigureAnalyzers<Bootstrapper>(Action<IAnalyzerCollection>) TBootstrapper
ConfigureCommands<Bootstrapper>(Action<IConfigurator>) TBootstrapper
ConfigureEngine<Bootstrapper>(Action<IEngine>) TBootstrapper
ConfigureFileSystem<Bootstrapper>(Action<IFileSystem, IReadOnlySettings, IServiceCollection>) TBootstrapper
ConfigureFileSystem<Bootstrapper>(Action<IFileSystem, IReadOnlySettings>) TBootstrapper
ConfigureFileSystem<Bootstrapper>(Action<IFileSystem>) TBootstrapper
ConfigureProcesses<Bootstrapper>(Action<Processes>) TBootstrapper
Configures processes to launch.
ConfigureServices<Bootstrapper>(Action<IServiceCollection, IReadOnlySettings, IReadOnlyFileSystem>) TBootstrapper
ConfigureServices<Bootstrapper>(Action<IServiceCollection, IReadOnlySettings>) TBootstrapper
ConfigureServices<Bootstrapper>(Action<IServiceCollection>) TBootstrapper
ConfigureSettings<Bootstrapper>(Action<ISettings, IServiceCollection, IReadOnlyFileSystem>) TBootstrapper
ConfigureSettings<Bootstrapper>(Action<ISettings, IServiceCollection>) TBootstrapper
ConfigureSettings<Bootstrapper>(Action<ISettings>) TBootstrapper
ConfigureTemplates<Bootstrapper>(Action<Templates>) TBootstrapper
Configures the set of template modules.
ConfigureThemePaths<Bootstrapper>(Action<PathCollection>) TBootstrapper
DeployToAzureAppService<Bootstrapper>(Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPages<Bootstrapper>(Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPages<Bootstrapper>(Config<string>, Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPagesBranch<Bootstrapper>(Config<string>, Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToGitHubPagesBranch<Bootstrapper>(Config<string>, Config<string>, Config<string>, Config<string>, Config<string>) TBootstrapper
DeployToNetlify<Bootstrapper>(Config<string>, Config<string>) TBootstrapper
ModifyPipeline(string, Action<IPipeline>) Bootstrapper
Modifies an existing pipeline with name name.
ModifyTemplate<Bootstrapper>(string, Func<IModule, IModule>) TBootstrapper
Modifies an existing template.
RemoveTemplate<Bootstrapper>(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<Bootstrapper>(IModule) TBootstrapper
SetDefaultLayoutTemplate<Bootstrapper>(string) TBootstrapper
SetFailureLogLevel<Bootstrapper>(LogLevel) TBootstrapper
SetOutputPath<Bootstrapper>(NormalizedPath) TBootstrapper
SetRootPath<Bootstrapper>(NormalizedPath) TBootstrapper
SetThemePath<Bootstrapper>(NormalizedPath) TBootstrapper
SubscribeEvent<TEvent>(AsyncEventHandler<TEvent>) IBootstrapper
SubscribeEvent<TEvent>(EventHandler<TEvent>) IBootstrapper
ThrowIfNull<Bootstrapper>(string) T
ToDocument<Bootstrapper>(IContentProvider) IDocument
ToDocument<Bootstrapper>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<Bootstrapper>(NormalizedPath, IContentProvider) IDocument
ToDocument<Bootstrapper>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<Bootstrapper>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<Bootstrapper>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument