default

The hibana library re-exports various Lume helper plugins and utility functions designed to enhance Lume static site generation projects.

f
addLanguageAlternate

Helper function to manually add language alternate links to a schema

f
addOSClass

Adds OS detection class to document body. Convenience function that automatically adds 'os-{platform}' class.

f
breadcrumbSchema

Creates a breadcrumb schema preprocessor

I
BreadcrumbSchemaOptions

Configuration options for breadcrumb schema generation

f
createBreadcrumbSchema

Helper function to manually create a breadcrumb schema object

f
cssBanner

A Lume plugin that prepends a CSS comment banner to all .css files.

T
DateFormat

Format types supported by the filter

f
deferPagefind

Lume plugin to defer the loading of Pagefind CSS and JS.

f
detectOS

Detects the user's operating system from the user agent string. Useful for platform-specific styling or functionality.

f
externalLinksIcon

Adds an external link icon to <a> anchor elements that point to external sites. Skips links inside elements with the class .no-external-icon.

f
fixFontPaths

Generates a shell command to fix font paths

I
FixFontPathsOptions

Configuration options for font path fixing

f
generateDoctypeCommand

Generates a shell command string for DOCTYPE injection

f
generateFontPathFixes

Generates individual fix commands for manual registration

I
HomeNames

Home page names for different languages

f
injectDoctype

Creates an event listener function that injects DOCTYPE into all HTML files

I
InjectDoctypeOptions

Configuration options for DOCTYPE injection

f
languageAlternatesSchema

Creates a language alternates schema preprocessor

I
LanguageAlternatesSchemaOptions

Configuration options for language alternate schema linking

f
loadVendorScript

Utility function to load an external vendor script.

f
markdownMetadata

Creates a markdown metadata preprocessor

I
MarkdownMetadataOptions

Configuration options for markdown metadata extraction

T
OS

Operating systems that can be detected

f
prefersReducedMotion

Checks if the user prefers reduced motion based on their system settings. Important for accessibility - animations should be disabled when this returns true.

f
shuffle

A Lume plugin to register the filter "shuffle" that shuffles an array.

f
temporalDate

Creates a Temporal API-based date filter function

I
TemporalDateOptions

Configuration options for the temporal date filter

I
I
TOCNode

A single node in the table of contents tree.

f
trapFocus

Traps focus within a given container element. Useful for modal dialogs to prevent users from tabbing outside the modal.

f
ventoHeadingAnchors

Adds ID and anchor links to heading elements in Vento-rendered pages.

f
ventoTOC

Generates a table of contents (TOC) from headings in Vento-rendered pages.

f
ventoTOCInject

Injects TOC HTML into pages at the injection marker