add search button to docs

[Almenon]

I'm very suprised there is not search functionality in the node docs. This would be a great addition to the docs and make it easier to navigate inside them.

workaround: google (not quite as convenient)

[vsemozhetbyt]

If you need just API docs, you can use the browser search on the page with docs consolidated in one page:

https://nodejs.org/api/all.html

[Almenon]

that's another good workaround, although it would still be nice to be able to search from inside pages like https://nodejs.org/api/child_process.html

[vsemozhetbyt]

cc @nodejs/website

[vsemozhetbyt]

You may also post the request in https://github.com/nodejs/nodejs.org — that repository is closer to this issue.

[Almenon]

will do - thanks

[ryzokuken]

As suggested by @vsemozhetbyt, the appropriate repository for this issue is nodejs/nodejs.org

Now that an issue has been submitted in there, this one should be closed.

[fhemberger]

But docs are living in this repo, not on the website.

[ryzokuken]

@fhemberger I might be wrong, but I think they wanted to have a search bar on this page. Isn't the source code for that in the nodejs.org repo?

[fhemberger]

@ryzokuken No, it's right here:
https://github.com/nodejs/node/tree/master/doc/api

Common misconception. ;)

[tniessen]

@ryzokuken The docs are maintained from within this repo.

[ryzokuken]

Oh, my bad. The more you know, I guess.

[vsemozhetbyt]

Sorry, I just thought that such a bar would be added by some scripts at the site building stage. But if it should be added statically to HTML sources by the tools/doc/html.js or dynamically to pages by some script in the doc/api_assets, then sure, this is the domain of this repository.

[tniessen]

Most search bars require a server-side implementation though, unless we want to include a client-side index of keywords etc. This might become a bigger project, for the meantime, there are search engines and CTRL+F.

[ryzokuken]

@tniessen as long as the text under consideration is on the currently rendered page, Ctrl+F works perfectly, agreed. I believe they wanted to perform an API-wide search though, not limiting to the same page.

Perhaps we could consider using something like Docusaurus instead?

[tniessen]

Many (if not most) API documentations don't have a search function, maybe an autocomplete feature (Hash → crypto.createHash, ...), but usually nothing complicated. Maybe a site-wide search function is something to consider for @nodejs/website-redesign, but I am personally happy with the status quo. (Even if certain sites have search functionality, I often end up using Google...)

[sotayamashita]

@ryzokuken

Perhaps we could consider using something like Docusaurus instead?

Good idea but it too big so what about to extract a search feature from Docusaurus . I suggest @nodejs/website-redesign use Algolia to implement the feature. It is free for OSS 💯.

[apapirovski]

It doesn't seem there's much progress here or anything really to be done. If anything happens it should be directed to the website-redesign repo.