Class DocsIndex

constructor

• new DocsIndex(root: string, sources: DocsSource[]): DocsIndex

  Parameters

  • root: string
  • sources: DocsSource[]

  Returns DocsIndex

Static ReadonlyMAX_FILES

Static ReadonlyMAX_TEXT

files

• get files(): number

  Returns number

search

• search(query: string, limit?: number): DocsHit[]

  Parameters

  • query: string
  • limit: number = 5

  Returns DocsHit[]

StaticsourcesOf

• sourcesOf(
      components: readonly { dir: string; name: string }[],
      moduleDocs: readonly { source: string; value: string }[],
  ): DocsSource[]

  README.md and docs/ of each component directory, then the modules' docs directories.

  Parameters

  • components: readonly { dir: string; name: string }[]
  • moduleDocs: readonly { source: string; value: string }[]

  Returns DocsSource[]

Staticsplit

• split(markdown: string, file: string, source: string): DocsSection[]

  Splits Markdown at headings, ignoring # lines inside fenced code.

  Parameters

  • markdown: string
  • file: string
  • source: string

  Returns DocsSection[]

Staticterms

• terms(query: string): string[]

  Lowercased words of the query; words of two characters or fewer only when nothing else is left.

  Parameters

  • query: string

  Returns string[]