mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-22 13:50:09 +00:00
Refactor and clear up README file
This commit is contained in:
Marc Cornellà
parent
d982e1200f
commit
c481c62bc9
1 changed files with 41 additions and 66 deletions
|
|
@ -1,83 +1,60 @@
|
||||||
## Rationale ##
|
## Introduction ##
|
||||||
|
|
||||||
> Searches for your Frontend contents more easier
|
> Searches for your frontend web development made easier
|
||||||
|
|
||||||
|
|
||||||
## Instalation ##
|
## Installation ##
|
||||||
|
|
||||||
|
Open your `~/.zshrc` file and enable the `frontend-search` plugin:
|
||||||
|
|
||||||
Open your `.zshrc` file and load `frontend-search` plugin
|
```zsh
|
||||||
|
|
||||||
|
plugins=( ... frontend-search)
|
||||||
|
|
||||||
```bash
|
|
||||||
...
|
|
||||||
plugins=( <your-plugins-list>... frontend-search)
|
|
||||||
...
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Commands ##
|
## Usage ##
|
||||||
|
|
||||||
All command searches are accept only in formats
|
You can use the frontend-search plugin in these two forms:
|
||||||
|
|
||||||
* `frontend <search-content> <search-term>`
|
* `frontend <context> <term> [more terms if you want]`
|
||||||
* `<search-content> <search-term>`
|
* `<context> <term> [more terms if you want]`
|
||||||
|
|
||||||
For more informations, please run help command (are similars)
|
For example, these two are equivalent:
|
||||||
|
|
||||||
* `frontend -h`
|
```zsh
|
||||||
* `frontend --help`
|
$ frontend angularjs dependency injection
|
||||||
* `frontend help`
|
$ angularjs dependency injection
|
||||||
|
```
|
||||||
|
|
||||||
The search content are
|
Available search contexts are:
|
||||||
|
|
||||||
* `jquery <api.jquery.com>`
|
| context | URL |
|
||||||
* `mdn <developer.mozilla.org>`
|
|---------------|--------------------------------------------------------------------------|
|
||||||
* `compass <compass-style.org>`
|
| angularjs | `https://google.com/search?as_sitesearch=angularjs.org&as_q=` |
|
||||||
* `html5please <html5please.com>`
|
| aurajs | `http://aurajs.com/api/#stq=` |
|
||||||
* `caniuse <caniuse.com>`
|
| bem | `https://google.com/search?as_sitesearch=bem.info&as_q=` |
|
||||||
* `aurajs <aurajs.com>`
|
| bootsnipp | `http://bootsnipp.com/search?q=` |
|
||||||
* `dartlang <api.dartlang.org/apidocs/channels/stable/dartdoc-viewer>`
|
| caniuse | `http://caniuse.com/#search=` |
|
||||||
* `lodash <search>`
|
| codepen | `http://codepen.io/search?q=` |
|
||||||
* `qunit <api.qunitjs.com>`
|
| compass | `http://compass-style.org/search?q=` |
|
||||||
* `fontello <fontello.com>`
|
| cssflow | `http://www.cssflow.com/search?q=` |
|
||||||
* `bootsnipp <bootsnipp.com>`
|
| dartlang | `https://api.dartlang.org/apidocs/channels/stable/dartdoc-viewer/dart:` |
|
||||||
* `cssflow <cssflow.com>`
|
| emberjs | `http://emberjs.com/api/#stp=1&stq=` |
|
||||||
* `codepen <codepen.io>`
|
| fontello | `http://fontello.com/#search=` |
|
||||||
* `unheap <www.unheap.com>`
|
| html5please | `http://html5please.com/#` |
|
||||||
* `bem <google.com/search?as_q=<search-term>&as_sitesearch=bem.info>`
|
| jquery | `https://api.jquery.com/?s=` |
|
||||||
* `smacss <google.com/search?as_q=<search-term>&as_sitesearch=smacss.com>`
|
| lodash | `https://devdocs.io/lodash/index#` |
|
||||||
* `angularjs <google.com/search?as_q=<search-term>&as_sitesearch=angularjs.org>`
|
| mdn | `https://developer.mozilla.org/search?q=` |
|
||||||
* `reactjs <google.com/search?as_q=<search-term>&as_sitesearch=facebook.github.io/react>`
|
| npmjs | `https://www.npmjs.com/search?q=` |
|
||||||
* `emberjs <emberjs.com>`
|
| qunit | `https://api.qunitjs.com/?s=` |
|
||||||
* `stackoverflow <stackoverflow.com>`
|
| reactjs | `https://google.com/search?as_sitesearch=facebook.github.io/react&as_q=` |
|
||||||
* `npmjs <npmjs.com>`
|
| smacss | `https://google.com/search?as_sitesearch=smacss.com&as_q=` |
|
||||||
|
| stackoverflow | `http://stackoverflow.com/search?q=` |
|
||||||
|
| unheap | `http://www.unheap.com/?s=` |
|
||||||
|
|
||||||
|
If you want to have another context, open an Issue and tell us!
|
||||||
## Aliases ##
|
|
||||||
|
|
||||||
There are a few aliases presented as well:
|
|
||||||
|
|
||||||
* `jquery` A shorthand for `frontend jquery`
|
|
||||||
* `mdn` A shorthand for `frontend mdn`
|
|
||||||
* `compass` A shorthand for `frontend compass`
|
|
||||||
* `html5please` A shorthand for `frontend html5please`
|
|
||||||
* `caniuse` A shorthand for `frontend caniuse`
|
|
||||||
* `aurajs` A shorthand for `frontend aurajs`
|
|
||||||
* `dartlang` A shorthand for `frontend dartlang`
|
|
||||||
* `lodash` A shorthand for `frontend lodash`
|
|
||||||
* `qunit` A shorthand for `frontend qunit`
|
|
||||||
* `fontello` A shorthand for `frontend fontello`
|
|
||||||
* `bootsnipp` A shorthand for `frontend bootsnipp`
|
|
||||||
* `cssflow` A shorthand for `frontend cssflow`
|
|
||||||
* `codepen` A shorthand for `frontend codepen`
|
|
||||||
* `unheap` A shorthand for `frontend unheap`
|
|
||||||
* `bem` A shorthand for `frontend bem`
|
|
||||||
* `smacss` A shorthand for `frontend smacss`
|
|
||||||
* `angularjs` A shorthand for `frontend angularjs`
|
|
||||||
* `reactjs` A shorthand for `frontend reactjs`
|
|
||||||
* `emberjs` A shorthand for `frontend emberjs`
|
|
||||||
* `stackoverflow` A shorthand for `frontend stackoverflow`
|
|
||||||
* `npmjs` A shorthand for `frontend npmjs`
|
|
||||||
|
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
|
@ -86,5 +63,3 @@ There are a few aliases presented as well:
|
||||||
+ <https://plus.google.com/+WilsonMendes>
|
+ <https://plus.google.com/+WilsonMendes>
|
||||||
+ <https://twitter.com/willmendesneto>
|
+ <https://twitter.com/willmendesneto>
|
||||||
+ <http://github.com/willmendesneto>
|
+ <http://github.com/willmendesneto>
|
||||||
|
|
||||||
New features comming soon.
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue