backstage / backstage/mkdocs-monorepo-plugin
searching on numbers
- Dominant language
- Python
- Stars
- 400
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
Thank you for creating this plugin.
We are using it to connect multiple MkDocs sites as one big help system for our users.
We want to search on numbers like ``2020`` or ``X2GO``. So we changed the regular expression for ``wordCharacters`` in ``/usr/local/lib/python3.8/site-packages/mkdocs/contrib/search/lunr-language/lunr.nl.js`` and ``/usr/local/lib/python3.8/site-packages/material/assets/javascripts/lunr/min/lunr.nl.min.js`` to include numbers. This works fine with a single MkDocs site. However when we use it with monorepo this does not work. Can you fix this?
Contributor guide
Research direction
Inspect the search assets at /usr/local/lib/python3.8/site-packages/mkdocs/contrib/search/lunr-language/lunr.nl.js and /usr/local/lib/python3.8/site-packages/material/assets/javascripts/lunr/min/lunr.nl.min.js, then reproduce the difference between a single MkDocs site and the monorepo setup. Done means searches for numeric terms such as 2020 and X2GO work when multiple documentation sites are combined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, python
- Domain
- documentation, search
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100