🐤 Canary

Appearance

@getcanary/docusaurus-theme-search-pagefind ​

npm (@1.0.2)

Anything missing here?

This page is generated from jsdoc in packages/docusaurus-theme-search-pagefind.

js
/** @type {import('@docusaurus/types').Config} */
const config = {
  ...
  themes: [
    [
      require.resolve("@getcanary/docusaurus-theme-search-pagefind"),
      options // the "Options" type is defined in this page.
    ],
  ],
};

Options

pagefind

PagefindRanking

includeRoutes

Array.<string>

excludeRoutes

Array.<string>

styles

Record.<string, string>

tabs

Array.<TabDefinitions>

tags

Array.<TagDefinition>

verbose

boolean

maxPages

number

maxSubResults

number

path

string

_base

string

_replace

string

PagefindOptions

ranking

PagefindRanking

PagefindRanking

pageLength

number

termFrequency

number

termSimilarity

number

termSaturation

number

TabDefinitions

name

string

pattern

string

options

Object

https://github.com/micromatch/picomatch#options

TagDefinition

name

string

pattern

string

options

Object

https://github.com/micromatch/micromatch#options