stow/oh-my-zsh/.oh-my-zsh/plugins/frontend-search/README.md

   1 ## Introduction
   2
   3 > Searches for your frontend web development made easier
   4
   5 ## Installation
   6
   7 Open your `~/.zshrc` file and enable the `frontend-search` plugin:
   8
   9 ```zsh
  10
  11 plugins=( ... frontend-search)
  12
  13 ```
  14
  15 ## Usage
  16
  17 You can use the frontend-search plugin in these two forms:
  18
  19 - `frontend <context> <term> [more terms if you want]`
  20 - `<context> <term> [more terms if you want]`
  21
  22 For example, these two are equivalent:
  23
  24 ```zsh
  25 $ angular dependency injection
  26 # Will turn into ...
  27 $ frontend angular dependency injection
  28 ```
  29
  30 Available search contexts are:
  31
  32 | context       | URL                                                                         |
  33 | ------------- | --------------------------------------------------------------------------- |
  34 | angular       | `https://angular.io/?search=`                                               |
  35 | angularjs     | `https://google.com/search?as_sitesearch=angularjs.org&as_q=`               |
  36 | bem           | `https://google.com/search?as_sitesearch=bem.info&as_q=`                    |
  37 | bootsnipp     | `https://bootsnipp.com/search?q=`                                           |
  38 | bundlephobia  | `https://bundlephobia.com/result?p=`                                        |
  39 | caniuse       | `https://caniuse.com/#search=`                                              |
  40 | codepen       | `https://codepen.io/search?q=`                                              |
  41 | compassdoc    | `http://compass-style.org/search?q=`                                        |
  42 | cssflow       | `http://www.cssflow.com/search?q=`                                          |
  43 | dartlang      | `https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart:`     |
  44 | emberjs       | `https://www.google.com/search?as_sitesearch=emberjs.com/&as_q=`            |
  45 | flowtype      | `https://google.com/search?as_sitesearch=flow.org/en/docs/&as_q=`           |
  46 | fontello      | `http://fontello.com/#search=`                                              |
  47 | github        | `https://github.com/search?q=`                                              |
  48 | html5please   | `https://html5please.com/#`                                                 |
  49 | jestjs        | `https://www.google.com/search?as_sitesearch=jestjs.io&as_q=`               |
  50 | jquery        | `https://api.jquery.com/?s=`                                                |
  51 | lodash        | `https://devdocs.io/lodash/index#`                                          |
  52 | mdn           | `https://developer.mozilla.org/search?q=`                                   |
  53 | nodejs        | `https://www.google.com/search?as_sitesearch=nodejs.org/en/docs/&as_q=`     |
  54 | npmjs         | `https://www.npmjs.com/search?q=`                                           |
  55 | packagephobia | `https://packagephobia.now.sh/result?p=`                                    |
  56 | qunit         | `https://api.qunitjs.com/?s=`                                               |
  57 | reactjs       | `https://google.com/search?as_sitesearch=facebook.github.io/react&as_q=`    |
  58 | smacss        | `https://google.com/search?as_sitesearch=smacss.com&as_q=`                  |
  59 | stackoverflow | `https://stackoverflow.com/search?q=`                                       |
  60 | typescript    | `https://google.com/search?as_sitesearch=www.typescriptlang.org/docs&as_q=` |
  61 | unheap        | `http://www.unheap.com/?s=`                                                 |
  62 | vuejs         | `https://www.google.com/search?as_sitesearch=vuejs.org&as_q=`               |
  63
  64 If you want to have another context, open an Issue and tell us!
  65
  66 ## Fallback search behaviour
  67
  68 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.
  69
  70 ## Author
  71
  72 **Wilson Mendes (willmendesneto)**
  73
  74 - <https://twitter.com/willmendesneto>
  75 - <https://github.com/willmendesneto>