Search

module Search


Assembly	`Nacara.Plugin.Search`
Attributes	`[<RequireQualifiedAccess>]`

Functions and values

binaryPath (value: string option) (options: SearchOptions) : SearchOptions

Path of an existing pagefind binary.

Parameter
`value`	The value to use.
`options`	The options so far.

defaults: SearchOptions

pagefind () : IPlugin

Search powered by pagefind, with its default options.

pagefindWith (configure: SearchOptions -> SearchOptions) : IPlugin

Search powered by pagefind, configured.

Parameter
`configure`	Given the defaults, the options to use. Anything it leaves alone keeps its default.

register (site: Site) : Site

Add search to a site.

registerWith (configure: SearchOptions -> SearchOptions) (site: Site) : Site

Add search to a site, configured.

Parameter
`configure`	Given the defaults, the options to use. Anything it leaves alone keeps its default.
`site`	The site being described.

rootSelector (value: string) (options: SearchOptions) : SearchOptions

CSS selector of the element pagefind should index as the page body.

Parameter
`value`	The value to use.
`options`	The options so far.

trigger (site: SiteInfo) : string

Markup for the search box, to place in the navbar.

Styled with the theme's tokens, so it belongs in the navbar as it is.

Parameter
`site`	Where the site is served from, so the widget finds the index belonging to this build.

NavbarEnd = [ NavbarDynamicWidget Search.trigger ]