Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukeocodes/netlify-plugin-opensearch
Automatically generate opensearch search.xml file with Netlify
https://github.com/lukeocodes/netlify-plugin-opensearch
netlify netlify-plugin nodejs opensearch search
Last synced: 1 day ago
JSON representation
Automatically generate opensearch search.xml file with Netlify
- Host: GitHub
- URL: https://github.com/lukeocodes/netlify-plugin-opensearch
- Owner: lukeocodes
- License: mit
- Created: 2020-05-29T11:01:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-06-26T09:50:33.000Z (over 4 years ago)
- Last Synced: 2024-05-01T15:09:05.882Z (7 months ago)
- Topics: netlify, netlify-plugin, nodejs, opensearch, search
- Language: JavaScript
- Homepage: https://netlify-plugins-by-lukeocodes.netlify.app
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Netlify Opensearch Plugin
Automatically generate [OpenSearch](http://a9.com/-/spec/opensearch/1.1/) 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-plugins-by-lukeocodes.netlify.app](https://netlify-plugins-by-lukeocodes.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.
```toml
[[plugins]]
package = "netlify-plugin-opensearch"
```
Default config will generate the following file at `https://your-site-name.netlify.app/search.xml`
```xml
Search
```
## Options
The available options.
| plugins.inputs | type | required | default | description |
|---|---|---|---|---|
| searchUrl | String | false | `/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 | A description of the site to search. **It must be 1024 or fewer characters** |
| siteTags | String|null | false | null | Comma separated list of keywords and strings |
| siteContact | String|null | false | null | Email address to contact the site |
### Options Applied
How to use these options:
```toml
[[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 = "[email protected]"
```
Which will produce the following file at `https://your-site-name.netlify.app/opensearch.xml`:
```xml
My Site
Search cool content from my site
my site
[email protected]
```
### Options On the Demo Site
For more context, this is how the demo site is configured:
```toml
[[plugins]]
package = "netlify-plugin-opensearch"
[plugins.inputs]
siteShortName = "Demo Site"
siteDescription = "Find stuff on the demo site"
siteTags = "demos"
siteContact = "[email protected]"
```
Which produced the following file as you can [see here](https://netlify-plugin-algolia-index.netlify.app/search.xml)
```xml
Demo Site
Find stuff on the demo site
demos
[email protected]
```
## Install on your website
Now, a search metatag to the head of your site, changing `search.xml` to match your configuration above.
```html
```
## To do
- Better support for the OpenSearch specification [as documented here](http://a9.com/-/spec/opensearch/1.1/) and [here](https://developer.mozilla.org/en-US/docs/Web/OpenSearch).
## Contributing
Make pull-requests, but follow [code of conduct](CODE_OF_CONDUCT.md) please.