mdn.io icon indicating copy to clipboard operation
mdn.io copied to clipboard

Create a simple index page with OpenSearch metadata

Open romulof opened this issue 5 years ago • 2 comments

With this metadata browsers can suggest to add mdn.io as a search engine.

For example, here is how Firefox presents it: https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox#w_add-a-search-engine-from-the-address-bar

To add it, simply add in your index page:

<link rel="search"
      type="application/opensearchdescription+xml"
      href="https://mdn.io/opensearch.xml"
      title="MDN Web Docs"
/>

And host /opensearch.xml that should be something like this:

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
                       xmlns:moz="http:/www.mozilla.org/2006/browser/search/"
>
    <ShortName>MDN Web Docs</ShortName>
    <Description>Search MDN Web Docs</Description>
    <InputEncoding>UTF-8</InputEncoding>
    <Image width="16" height="16" type="image/png">
        https://developer.mozilla.org/static/img/favicon32.7f3da72dcea1.png
    </Image>
    <Url type="text/html" method="get" template="http://mdn.io/{searchTerms}" />
    <moz:SearchForm>http://mdn.io</moz:SearchForm>
</OpenSearchDescription>

More info here: https://developer.mozilla.org/en-US/docs/Web/OpenSearch

romulof avatar Jul 03 '19 15:07 romulof

Sounds like a great idea, first we'd need an index page! 😄 Would love to accept a PR for something basic. I'm assuming this would require someone to navigate to the index page first?

blakeembrey avatar Jul 04 '19 02:07 blakeembrey

In Chrome (don't know about other browsers yet) you can add a custom search engine to set a text shortcut.

Go to chrome://settings/searchEngines add a custom keyword (shortcut, e.g. "md") and the URL https://mdn.io/%s.

See https://support.google.com/chrome/answer/95426?hl=en#ts

tricki avatar Feb 25 '21 00:02 tricki