netlify-plugin-opensearch

Netlify Opensearch Plugin

Automatically generate OpenSearch search.xml file postBuild on Netlify deploy.

What is this?

Ever wondered why when you type a URL and the browser says "press TAB to search"? That's opensearch! In Chrome or Chromium, the URL bar (or Omnibox) offers the ability to search a site without navigating to the sites homepage. Once Chromium has determined it can search a site, any time the user types the URL of the site the user is reminded they can "press TAB to search".

Once the user presses TAB, they can type in a string and presses the enter. This automatically sents the user to the URL of the site search, along with their search terms, where the search is performed and results shown.

Type in the URL of the search demo site and see! https://netlify-plugin-algolia-index.netlify.app

Then press TAB and you can search the demo site directly!

Usage

To install, add the plugin in your netlify.toml. No config is required.

[[plugins]]
  package = "netlify-plugin-opensearch"

Default config will generate the following file at https://your-site-name.netlify.app/search.xml

<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>Search</ShortName>
  <Url type="text/html" template="https://your-site-name.netlify.app/search?q={searchTerms}"/>
</OpenSearchDescription>

Options

The available options.

plugins.inputs	type	required	default	description
searchUrl	String	false	<env.URL>/search?q=	The URL of the search query, remembering that the search parameters are concatenated to the end as {searchTerms}
searchFile	String	false	search.xml	The name of the file to be saved to. You'll need to configure your metadata to point to this file.
siteShortName	String	false	Search	A short name of the site to search. It must be 16 or fewer characters
siteDescription	String	null	false	null
siteTags	String	null	false	null
siteContact	String	null	false	null

Options Applied

How to use these options:

[[plugins]]
  package = "netlify-plugin-opensearch"
    [plugins.inputs]
      searchUrl = "https://different-website.com/search?q="
      searchFile = "opensearch.xml"
      siteShortName = "My Site"
      siteDescription = "Search cool content from my site"
      siteTags = "my site"
      siteContact = "[e-mail]"

Which will produce the following file at https://your-site-name.netlify.app/opensearch.xml:

<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>My Site</ShortName>
  <Url type="text/html" template="https://different-website.com/search?q={searchTerms}"/>
  <Description>Search cool content from my site</Description>
  <Tags>my site</Tags>
  <Contact>[e-mail]</Contact>
</OpenSearchDescription>

Options On the Demo Site

For more context, this is how the demo site is configured:

[[plugins]]
  package = "netlify-plugin-opensearch"
    [plugins.inputs]
      siteShortName = "Demo Site"
      siteDescription = "Find stuff on the demo site"
      siteTags = "demos"
      siteContact = "[e-mail]"

Which produced the following file as you can see here

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>Demo Site</ShortName>
  <Url type="text/html" template="https://netlify-plugin-algolia-index.netlify.app/search?q={searchTerms}"/>
  <Description>Find stuff on the demo site</Description>
  <Tags>demos</Tags>
  <Contact>[e-mail]</Contact>
</OpenSearchDescription>

Install on your website

Now, a search metatag to the head of your site, changing search.xml to match your configuration above.

<link rel="search" href="search.xml" type="application/opensearchdescription+xml" title="Your Site Name" />

To do

• Better support for the OpenSearch specification as documented here and here.

Contributing

Make pull-requests, but follow code of conduct please.