nestjs / docs.nestjs.com

The official documentation https://docs.nestjs.com 📕
MIT License
1.2k stars 1.74k forks source link

Add search bar #263

Closed yunyu950908 closed 4 years ago

yunyu950908 commented 5 years ago

[ ] Regression 
[ ] Bug report
[ ] Feature request
[x] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.
Sharlaan commented 5 years ago

Yes, the official documentation is really missing some global search bar.

simlej commented 5 years ago

Hi ! Algolia provides an excellent, free solution : https://community.algolia.com/docsearch/

Kessir commented 5 years ago

Hi, there's a label PRs open but I don't see the PR for this.

s-pace commented 5 years ago

👋 I am working on DocSearch.

Here is a demo for you: DocSearch + nestjs

Code to integrate:


- Add a search input in your page if you don't have any yet. Then update the inputSelector value in JS snippet to a CSS selector that targets your search input field.
- Optionally customize the look and feel by following [the DocSearch documentation](https://community.algolia.com/docsearch/styling.html)
- You can also check [your configuration in our GitHub repo](https://github.com/algolia/docsearch-configs/blob/master/configs/nestjs.json).
kamilmysliwiec commented 5 years ago

I like it @s-pace, thanks! I'll play with this a little bit shortly

s-pace commented 5 years ago

Cool, let me know :) @kamilmysliwiec

khawarizmus commented 5 years ago

any progress with this?

s-pace commented 5 years ago

Happy to PR it if you will merge it @gimyboya

khawarizmus commented 5 years ago

@s-pace I am not part of the team (maybe yet?) but I am sure @kamilmysliwiec can take a look at this and assess. I believe having searchable docs is very useful.

pellul commented 5 years ago

Any news about it? It would be awesome to have this feature.

s-pace commented 5 years ago

@pellul I am currently off but I would be happy to PR it if you will merge it and provide me the right place to do so. It will be done in 3 weeks

kamilmysliwiec commented 4 years ago

Search has been added!