Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 14:26:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/search
History
Griatch f29f843803 Revert to default search, it's enough for now
2020-05-23 16:19:06 +02:00
..
css Move to custom search plugin by borrowing from Mkdocs and existing plugins 2020-05-23 14:59:12 +02:00
js/search Revert to default search, it's enough for now 2020-05-23 16:19:06 +02:00
lunr-language Move to custom search plugin by borrowing from Mkdocs and existing plugins 2020-05-23 14:59:12 +02:00
__init__.py Revert to default search, it's enough for now 2020-05-23 16:19:06 +02:00
README.md Move to custom search plugin by borrowing from Mkdocs and existing plugins 2020-05-23 14:59:12 +02:00
searchbox.html Move to custom search plugin by borrowing from Mkdocs and existing plugins 2020-05-23 14:59:12 +02:00

README.md

Search plugin

This is a search plugin that modifies and combines code from two projects:

  • Sphinxcontrib-lunrsearch (https://github.com/rmcgibbo/sphinxcontrib-lunrsearch) - the lunr-index generation component was reworked to read more than just the api and addded supoort for using the lunr python library to pre-generate the search index.
  • Mkdocs lunr search (https://www.mkdocs.org/) - the javascript components with web-worker support, using the index generated by the above module.

Parsing of the documentation to create the index is custom.