gluster / ascii_binder_search_plugin Goto Github PK

If this project works fine according to everyone deployments then deploy it on pypi

• In the build process run flake8 for static code analysis
• Deploy the example documentation from the latest code on master to gh-pages

This way searches could be bounded by the version the user is considering. It'd be great ot be able to have multiple files searched for cross-version searching too.

There have been no updates/maintenance to this repo in the last 18 months. If there is reason to keep this repo open, please let me know. Otherwise, it will be archived on or after March 22, 2019.

@gluster/github-organization-admins

A line break in the file renders wrongly in the results page. The words are close together with no space.

Magic is awesome - but some verbosity would be nice too :)

Highlight the search word in the results prominently.

The clickable link in the search results is missing the / between the version and the file path.

i.e.

f26/foo/bar/baz.html

becomes

f26foo/bar/baz.html

where f26 is a version.

I believe the problem is the .replace here:

https://github.com/smitthakkar96/ascii_binder_search_plugin/blob/master/ascii_binder_search/static/search.html#L81

The directions (both before and after my README PR) indicate that you must run ascii_binder_search -s after manually downloading the search.html - this doesn't appear to be true.

This needs better documentation.

It'd be great to see a default integration on both the home page and the header for the documentation pages.

When I search for a word, I want all results of those two words in the same page to come up. Often, when people look at documentation, they're looking for matches to figure out if it is what they want.

We need to somehow indicate there is more, even if we can't display it all

It is unexpected behavior

The formatting of the headings especially show up prominently in the results, if we can add that to the stop words or exclude those from the index, it'll be useful in showing relevant results.