Pagefind 1.0 Release Planning

[bglw]

Tracking issue for remaining cleanup before 1.0

Work

• Investigate Some translated strings still appear in english #374
• Release notes
• Migration guide
• Re-enable and solidify NodeJS indexing tests
• Rename NodeJS API bundle- methods to output-
• Change NodeJS API Buffer types to Uint8Arrays
• Return relative paths from the index.getFiles() method for the NodeJS API
• Update word indexing splitting to also split on punctuation like < [ ( = " to help code and HTML index better.
• Update NodeJS addHTMLFile to take a url
• Add de-ranking weights as well as up-ranking
• Weight compound word results lower
• Use weightings when calculating excerpts

Documentation

• Update the language support table to reference latest state
• data-pagefind-weight usage
• Add new common solutions page
• NodeJS Indexing API
• Compound filtering
• Sub-results
  • JS API
  • Default UI
• New JS API initialization flow
• Update all references of _pagefind to pagefind
• Update CLI flags for source -> site and bundle -> output

Changelog

• Reference all contributed translation PRs
• Emoji support
• Weighting
• Compound filtering
• Sub results
• Check commit history for unmentioned bugfixes
• New JS API initialization flow
• BREAKING: Default output rename
• Deprecated/renamed CLI flags
• Improve search input on mobile #368
• Fix the static binary linking of Windows builds #344
• feat: allow directly passing HTMLElement to default pagefind ui options.element #331
• If a word is not in the index, find the longest matching prefix that is #315
• Changed from GitHub downloads to platform-specific npm packages
• Sanitized default UI titles
• Excerpt rework
• Node API
• word splitting