static_shock library
Classes
- Asset
- AssetContent
- AssetTransformer
- CombineFilters
- Component
- DataIndex
- A hierarchical index of data.
- DataLoader
- Loads data that might be needed by one or more pages.
- DirectoryPicker
- DirectoryRelativePath
- DraftingPlugin
- Plugin that helps with drafting content.
- ExcludeExtensions
-
A SourceFilter that filters out all files that have one of the given
extensions. - ExcludePrefixes
- Excludes any path which contains a directory or file name that begins with the given prefixes.
- Excluder
- ExtensionPicker
- FilePicker
- FilePrefixExcluder
- FileRelativePath
- Finisher
- An action that runs after all pages are loaded, indexed, and written to their destination.
- GitHubContributorsPlugin
- A StaticShockPlugin that loads lists of contributors into the pipeline data hierarchy.
- GitHubRepository
- Identifying information for a specific repository on GitHub.
- IncludeExtensions
-
A SourceFilter that filters out all files that don't have one of the
given
extensions, i.e., only files with the givenextensionsare pushed through the filter. - JinjaPageLoader
- JinjaPageRenderer
- JinjaPlugin
- Layout
- MarkdownPageLoader
- MarkdownPageRenderer
- MarkdownPlugin
- MarkdownRenderOptions
- Options for how to render Markdown to HTML.
- Page
- PageFilter
- PageLoader
- PageRenderer
- PagesIndex
- PageTransformer
- Picker
- PrettyPathPageTransformer
- Prettify the destination page path by making the page an index.html within a directory named after the page:
- PrettyUrlsPlugin
- PubPackagePlugin
- A StaticShockPlugin that looks up Pub information about one or more packages, and makes that information available to all pages.
- RedirectsFinisher
- Finisher that copies pages with redirects and adds appropriate HTML for the redirect.
- RedirectsPlugin
- A StaticShockPlugin that configures HTML redirects for pages that want redirects.
- RelativePath
- RssPlugin
- Plugin for generating RSS feeds.
- RssSiteConfiguration
- Configures top-level website info for the RssPlugin.
- SassAssetTransformer
- SassPlugin
- SourceDirectory
- SourceEntity
- SourceFile
- SourceFiles
- SourceFilter
- A filter that prevents visiting files that fail some condition.
- StaticShock
- The core of Static Shock.
- StaticShockPipeline
- A pipeline that runs a series of steps to generate a static website.
- StaticShockPipelineContext
- Information and file system access that's provided to various pipeline actors and also provided to plugins.
- StaticShockPlugin
- A Static Shock plugin.
- TailwindPlugin
- StaticShockPlugin that runs Tailwind CSS against the project's source files.
Properties
- rssDateFormat → DateFormat
-
The standard date format for dates within an RSS feed.
final
Functions
-
defaultPageToRssItemMapper(
RssSiteConfiguration config, Page page) → RssItem? - The default PageToRssItemMapper used by the RssPlugin.
-
isMenuEmpty(
StaticShockPipelineContext context) → (String, Function) -
Returns
trueif theYamlListof menu items is either empty, or it only contains items for non-existent pages. -
isMenuNonEmpty(
StaticShockPipelineContext context) → (String, Function) -
Returns
trueif theYamlListof menu items contains at least one item that corresponds to a Page that exists. -
A
StaticShockJinjaFilterBuilderwhose filter takes a list of YAML menu items and removes all the menu items for which no Page exists.
Typedefs
-
DataLoaderFunction
= Future<
Map< Function(StaticShockPipelineContext context)String, Object> > - PageToRssItemMapper = RssItem? Function(RssSiteConfiguration config, Page page)
-
Maps a Static Shock
pageto anRssItem, to be placed in an RSS feed. - StaticShockJinjaFunctionBuilder = (String, Function) Function(StaticShockPipelineContext context)
- Constructs and returns a Jinja function (filter or test), along with the function name, given the StaticShockPipelineContext.