- Namespace
- Statiq
.Sass - Interfaces
- Base Types
-
- object
- Module
- ParallelModule
Syntax
public class CompileSass : ParallelModule, IModule, IParallelModuleRemarks
The content of the input document is compiled to CSS and the content of the output document contains the compiled CSS stylesheet.
Any metadata prefixed with "Sass_" or "Sass-" (case-insensitive) will be
injected into the beginning of the Sass content as variables. Any spaces will
be converted to "-" and the "Sass_" or "Sass-" prefix will be removed for the
Sass variable name. Note that because these are injected at the top of the Sass
content, and because the order of metadata is undefined, variables defined this
way should not use other variables in their values. Using the !default
syntax in Sass files where metadata variables might override the ones in the
Sass file is one technique for working with metadata-defined Sass variables.
Properties
| Name | Property Type | Summary |
|---|---|---|
| Parallel | bool |
Indicates whether documents will be
processed by this module in parallel.
Inherited from ParallelModule
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from ParallelModule
|
| ExecuteInputAsync |
Task |
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| GenerateSourceMap |
CompileSass |
Specifies whether a source map should be generated (the default
behavior is
false).
|
| Include |
CompileSass |
Sets whether the source comments are included (by default they are not).
|
| With |
CompileSass |
Sets the output style to compact.
|
| With |
CompileSass |
Sets the output style to compressed.
|
| With |
CompileSass |
Sets the output style to expanded.
|
| WithImportPath |
CompileSass |
A delegate that processes the path in
@import statements.
|
| WithIncludePaths |
CompileSass |
Adds a list of paths to search while processing includes.
|
| WithInputPath |
CompileSass |
Specifies a delegate that should be used to get the input path for each
input document. This allows the Sass processor to search the right
file system and paths for include files. By default, the
Source
value is used for the input document path.
|
| With |
CompileSass |
Sets the output style to nested.
|