ohmyzsh

mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-20 19:31:58 +00:00

History

jackh d7fc9b87f9 fix(frontend-search): URL-encode search parameters (#10910 ) Fixes #10884 Closes #10910		2022-05-12 15:06:44 +02:00
..
_frontend	style(frontend-search): rename completion file to `_frontend`	2021-11-09 12:07:23 +01:00
frontend-search.plugin.zsh	fix(frontend-search): URL-encode search parameters (#10910 )	2022-05-12 15:06:44 +02:00
README.md	frontend-search: add packagephobia (#8908 )	2020-05-19 16:33:47 +02:00

README.md

Introduction

Searches for your frontend web development made easier

Installation

Open your ~/.zshrc file and enable the frontend-search plugin:


plugins=( ... frontend-search)

Usage

You can use the frontend-search plugin in these two forms:

frontend <context> <term> [more terms if you want]
<context> <term> [more terms if you want]

For example, these two are equivalent:

$ angular dependency injection
# Will turn into ...
$ frontend angular dependency injection

Available search contexts are:

context	URL
angular	`https://angular.io/?search=`
angularjs	`https://google.com/search?as_sitesearch=angularjs.org&as_q=`
bem	`https://google.com/search?as_sitesearch=bem.info&as_q=`
bootsnipp	`https://bootsnipp.com/search?q=`
bundlephobia	`https://bundlephobia.com/result?p=`
caniuse	`https://caniuse.com/#search=`
codepen	`https://codepen.io/search?q=`
compassdoc	`http://compass-style.org/search?q=`
cssflow	`http://www.cssflow.com/search?q=`
dartlang	`https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart:`
emberjs	`https://www.google.com/search?as_sitesearch=emberjs.com/&as_q=`
flowtype	`https://google.com/search?as_sitesearch=flow.org/en/docs/&as_q=`
fontello	`http://fontello.com/#search=`
github	`https://github.com/search?q=`
html5please	`https://html5please.com/#`
jestjs	`https://www.google.com/search?as_sitesearch=jestjs.io&as_q=`
jquery	`https://api.jquery.com/?s=`
lodash	`https://devdocs.io/lodash/index#`
mdn	`https://developer.mozilla.org/search?q=`
nodejs	`https://www.google.com/search?as_sitesearch=nodejs.org/en/docs/&as_q=`
npmjs	`https://www.npmjs.com/search?q=`
packagephobia	`https://packagephobia.now.sh/result?p=`
qunit	`https://api.qunitjs.com/?s=`
reactjs	`https://google.com/search?as_sitesearch=facebook.github.io/react&as_q=`
smacss	`https://google.com/search?as_sitesearch=smacss.com&as_q=`
stackoverflow	`https://stackoverflow.com/search?q=`
typescript	`https://google.com/search?as_sitesearch=www.typescriptlang.org/docs&as_q=`
unheap	`http://www.unheap.com/?s=`
vuejs	`https://www.google.com/search?as_sitesearch=vuejs.org&as_q=`

If you want to have another context, open an Issue and tell us!

Fallback search behaviour

The plugin will use Google as a fallback if the docs site for a search context does not have a search function. You can set the fallback search engine to DuckDuckGo by setting FRONTEND_SEARCH_FALLBACK='duckduckgo' in your ~/.zshrc file before Oh My Zsh is sourced.

Author

Wilson Mendes (willmendesneto)