nodejs
API documentation search
Would it be possible to implement search functionality in the API documentation section, https://nodejs.org/dist/latest-v14.x/docs/api/ ?
For example, if I want to quickly find the description for the "?.inspect" method, right now I have to
- Google for "site:https://nodejs.org/dist/latest-v14.x/docs/api inspect".
- Curse that it can't find "a damn thing."
- Navigate to https://nodejs.org/dist/latest-v14.x/docs/api manually.
- Scroll the left sidebar haphazardly all the way down, clicking random modules from time to time until I arrive at the util (I deal with multiple APIs: web, .NET, C++, so it sometimes feels frustratingly fuzzy what is it exactly I'm looking for this time).
- Then proceed through all the methods exported by the util module to find the method I want.
For comparison, MDN has solid search functionality, see the textbox in the right top corner - https://developer.mozilla.org/en-US/docs/Web/Guide#apis
@nodejs/nodejs-dev Is this something that has been implemented or is expected to be implemented on nodejs.dev?
Yes I'm working on an implementation here Demo https://staging.nodejs.dev/1677/ It currently only searches /learn content
I'll +1 that I've wished I could search the API documentation more easily. I resorted to cloning from github and then using grep a few times.
I could use some code reviews on my pr. https://github.com/nodejs/nodejs.dev/pull/1677
Search exists now on https://nodejs.dev. It searches the core docs and the /learn content 🎉
Amazing work! but just to know, why not in https://nodejs.org/en/docs/ too instead of only in nodejs.dev?
As @benhalverson is the same content on both, but, we're working into transferring the structure, layout and contents from nodejs.dev into nodejs.org :)
Closing as this is going to be done soon by the Metadata Docs Proposal + migration of stuff from nodejs.dev to here.