search

pastelsky / tsdocs

Browse type documentation for JS libraries
https://tsdocs.dev
MIT License
1.13k stars 25 forks source link

Support OpenSearch description format #25

Closed iamandrewluca closed 8 months ago

iamandrewluca commented 11 months ago

The OpenSearch description format can be used to describe the web interface of a search engine. This allows a website to describe a search engine for itself, so that a browser or other client application can use that search engine. OpenSearch is supported by (at least) Firefox, Edge, Safari, and Chrome. (See Reference Material for links to other browsers' documentation.) – https://developer.mozilla.org/en-US/docs/Web/OpenSearch

e.g. PR: https://github.com/kachkaev/njt/pull/45 e.g. https://njt.vercel.app/opensearch.xml

PS: might look into implementing this in the next weeks

pastelsky commented 11 months ago

This should be easy enough, so leaving this as a good first issue for someone to help implement.

  1. We'd want to redirect to /search/docs/

  2. We don't support partial package name searches, but might be a good idea to improve the error messaging with possible suggestions in cases of an error.