Skip to content

resolves #39 configuring additional stop words

Josh Clough requested to merge Josh_ChamSys/antora-lunr-extension-fork:issue-39-configure-additional-stop-words into main

Can now use the key extra_stop_words in a playbook to configure extra words that Lunr excludes from the search index. These can defined globally like this:

antora:
  extensions:
  - require: '@antora/lunr-extension'
    extra_stop_words: ['basically', 'actually']

Or on a language by language basis like this:

antora:
  extensions:
  - require: '@antora/lunr-extension'
    langauges:
    - en:
      extra_stop_words: ['basically', 'actually']
    - fr:
      extra_stop_words: ['empêche', 'fonctionnalité']

It is also possible to specify a langauge without stop words:

antora:
  extensions:
  - require: '@antora/lunr-extension'
    langauges:
    - en:
      extra_stop_words: ['basically', 'actually']
    - fr:
      extra_stop_words: ['empêche', 'fonctionnalité']
    - es

The one part of #39 this solution does not implement is support for regular expressions.

Edited by Josh Clough

Merge request reports