Move encrypted search entries to a separate file (besides seach_index.json)

[GreggGreen]

[GreggGreen]

  - encryptcontent:
      title_prefix: ''
      password_file: 'pwd.yml'
      password_button: true
      password_button_text: continue
      hljs: False
      arithmatex: False
      mermaid2: False
      search_index: 'dynamically'

[unverbuggt]

see here:

The default is 'encrypted', which means all encrypted pages are removed from the search index. So just remove search_index or set it to the default.

[GreggGreen]

But shouldn't the encrypted pages not show up in the search if you're not logged in, and decrypt when logged in so you can search them? It sounds hard to do so basically all encrypted pages are not searchable?

[unverbuggt]

On-the-fly search decryption in 'dynamically' mode works out of the box with the mkdocs theme and some others.

The material theme does include its own search plugin which cannot easily be controlled/modified by this plugin. There are some hacks which require to modify the source code of mkdocs-material and recompiling.

[GreggGreen]

I was thinking of making the search only kick in after 3 characters, which filters out the encryption pretty good. Just a simple fix.

[unverbuggt]

Next time, please be more specific when describing the issue.

Yes, it is bad that the encrypted texts are showing up as search topics. We could modify the normal search plugin (as we are already replacing it) to not show encrypted entries. But as stated, our influence on material's search plugin is limited. You'd have to check the documentation if there is a way to require a minimum amount of characters before results are listed.

But maybe we should keep search entries of encrypted pages in a separate file (besides search/search_index.json) and mix the entries in only after decryption... Let's keep this issue open as a reminder or to discuss this idea.