PageConfig class
The configuration for building a page.
This controls how a page is parsed, processed and built.
Constructors
-
PageConfig({bool enableFrontmatter = true, List<
DataLoader> dataLoaders = const [], TemplateEngine? templateEngine, Pattern? rawOutputPattern, List<SecondaryOutput> secondaryOutputs = const [], List<PageParser> parsers = const [], List<PageExtension> extensions = const [], List<CustomComponent> components = const [], List<PageLayout> layouts = const [], ContentTheme? theme}) -
const
Properties
-
components
→ List<
CustomComponent> -
A collection of custom components to render in the page.
final
-
dataLoaders
→ List<
DataLoader> -
The data loaders to use for loading additional data for the page.
final
- enableFrontmatter → bool
-
Whether to enable frontmatter parsing.
final
-
extensions
→ List<
PageExtension> -
The extensions to use for processing the parsed page nodes.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
layouts
→ List<
PageLayout> -
The layouts to use for building the page.
final
-
parsers
→ List<
PageParser> -
The parsers to use for parsing the page content.
final
- rawOutputPattern → Pattern?
-
A pattern to match pages that should output their raw content.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secondaryOutputs
→ List<
SecondaryOutput> -
A collection of secondary outputs to create for matching pages.
final
- templateEngine → TemplateEngine?
-
The template engine to use for preprocessing the page content before parsing.
final
- theme → ContentTheme?
-
The theme to use for the page.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
all(
{bool enableFrontmatter = true, List< DataLoader> dataLoaders = const [], TemplateEngine? templateEngine, Pattern? rawOutputPattern, List<SecondaryOutput> secondaryOutputs = const [], List<PageParser> parsers = const [], List<PageExtension> extensions = const [], List<CustomComponent> components = const [], List<PageLayout> layouts = const [], ContentTheme? theme}) → ConfigResolver - Resolves the given configuration for all pages.
-
match(
Map< Pattern, PageConfig> configs) → ConfigResolver - Resolves the first config for that the pattern matches the page path.