jaspr_content library
A package for building content-driven sites with Jaspr.
Classes
- BlogLayout
- A layout for blog articles.
- ComponentNode
- A node that represents a component.
- Content
- A component that wraps the content of a page and applies default typographic styles.
- ContentApp
- The root component for building a content-driven site.
- CustomComponent
- CustomComponentBase
- Base class for creating components based on a name pattern.
- DataLoader
- A data loader that loads additional data for a page.
- DocsLayout
- A layout for documentation pages.
- ElementNode
- A node that represents an element with a tag, attributes and children.
- EmptyLayout
- An empty layout with no additional elements.
- FilePageSource
- FilesystemDataLoader
- A data loader that loads data from the filesystem.
- FilesystemLoader
- A loader that loads routes from the filesystem.
- GitHubLoader
- A loader that loads routes from a GitHub repository.
- HeadingAnchorsExtension
- An extension that generates anchor links for headers in the page.
- HtmlParser
- A parser for HTML content.
- HtmlText
- InheritedSecondaryOutput
- JasprHtmlBlockSyntax
- LiquidTemplateEngine
- A template engine that uses the Liquid templating language.
- MarkdownOutput
- Outputs a secondary 'index.html.md' file for a markdown page containing its unparsed content.
- MarkdownParser
- A parser for Markdown content.
- MemoryDataLoader
- A data loader that loads data from memory.
- MemoryLoader
- A loader that loads routes from memory.
- MemoryPage
- A page that is loaded from memory.
- MemoryPageSource
- MustacheTemplateEngine
- A template engine that uses the Mustache templating language.
- Node
- A tree-like object that represents the content of a page.
- NodesBuilder
- Builds a list of nodes, including supported custom components.
- Page
- A single page of the site.
- PageConfig
- The configuration for building a page.
- PageExtension
- An extension that can post-process a page and its parsed nodes.
- PageLayout
- A layout for a page.
- PageLayoutBase
- A base implementation of a page layout.
- PageParser
- Parses a page into a list of nodes.
- PageSource
- RouteLoader
- A loader that loads routes and creates pages.
- RouteLoaderBase
- A base class for RouteLoader implementations.
- RSSFilter
- RSSItem
- RSSOutput
- Outputs a rss feed for your pages.
- SecondaryOutput
- A secondary output for a page.
- TableOfContents
- TableOfContentsExtension
- An extension that generates a table of contents from the headers in the page.
- TemplateEngine
- A template engine for preprocessing a page's content.
- TextNode
- A node that represents simple text content.
- TocEntry
Extension Types
- PageDataMap
- The data exposed to and used by the page, accessed with Page.data.
Extensions
- NodeExtension on Node
-
PageBuilderExtension
on Iterable<
PageParser> - PageContext on BuildContext
- Context extensions to get the current page and pages in a components build method.
- PageHandlersExtension on Page
- Common build steps that may be used in a page builder function.
- RouteLoaderExtension on RouteLoader
Typedefs
- ConfigResolver = PageConfig Function(PageSource)
- A function that resolves the configuration for a page based on its source.
-
CustomComponentBuilder
= Component Function(String name, Map<
String, String> attributes, Component? child) - A builder for creating components from a name, attributes, and child.
- DocumentBuilder = Document Function(Page page)
- GithubLoader = GitHubLoader
-
PageBuilder
= Future<
Component> Function(Page) - A function that builds a page based on its configuration.