Skip to content

Commit

Permalink
Replacing shell with sh so github can parse it correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
ericduran committed Sep 11, 2012
1 parent 79e607a commit f61ccb1
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/cli/commands/help.md
Expand Up @@ -5,7 +5,7 @@


Lists out the commands and tasks supported by yeoman and should print out the following to the console: Lists out the commands and tasks supported by yeoman and should print out the following to the console:


{% highlight shell %} {% highlight sh %}
yeoman init # Initialize and scaffold a new project using generator templates yeoman init # Initialize and scaffold a new project using generator templates
yeoman build # Build an optimized version of your app, ready to deploy yeoman build # Build an optimized version of your app, ready to deploy
yeoman server # Launch a preview server which will begin watching for changes yeoman server # Launch a preview server which will begin watching for changes
Expand Down
20 changes: 10 additions & 10 deletions docs/cli/commands/init.md
Expand Up @@ -18,7 +18,7 @@ By default we support Compass and CoffeeScript, so if your project includes any


If everything has been installed successfully, running `yeoman init` will present you with a welcome screen to kick off your project that looks a little like this: If everything has been installed successfully, running `yeoman init` will present you with a welcome screen to kick off your project that looks a little like this:


{% highlight shell %} {% highlight sh %}


_ .--------------------------. _ .--------------------------.
_|o|_ | Welcome to Yeoman, | _|o|_ | Welcome to Yeoman, |
Expand All @@ -40,50 +40,50 @@ Please answer the following:


Some of our supported custom generators include: Some of our supported custom generators include:


{% highlight shell %} {% highlight sh %}
yeoman init bbb #backbone boilerplate yeoman init bbb #backbone boilerplate
yeoman init angular #angularjs seed yeoman init angular #angularjs seed
yeoman init ember #ember app based on ember-rails yeoman init ember #ember app based on ember-rails
{% endhighlight %} {% endhighlight %}


Yeoman comes with a powerful system of Generators for scaffolding out applications using any number of boilerplates, frameworks and dependencies. Generators can be called in a project which has already been initialized with a basic Yeoman application structure OR may contain all of the files needed for the application structure themselves. By default, one can call a generator as follows: Yeoman comes with a powerful system of Generators for scaffolding out applications using any number of boilerplates, frameworks and dependencies. Generators can be called in a project which has already been initialized with a basic Yeoman application structure OR may contain all of the files needed for the application structure themselves. By default, one can call a generator as follows:


{% highlight shell %} {% highlight sh %}
yeoman init generatorName #e.g yeoman init angular yeoman init generatorName #e.g yeoman init angular
{% endhighlight %} {% endhighlight %}


In the case of a Generator named "angular", a grouping sub-generator called `all` may exist for scaffolding out all of the files needed for a new AngularJS application. One would use this as follows: In the case of a Generator named "angular", a grouping sub-generator called `all` may exist for scaffolding out all of the files needed for a new AngularJS application. One would use this as follows:


{% highlight shell %} {% highlight sh %}
yeoman init angular:all yeoman init angular:all
{% endhighlight %} {% endhighlight %}


The idea here is that the Generator would pull in AngularJS, its common dependencies and write out the boilerplate needed for a basic Controller and any other components the framework may require. The idea here is that the Generator would pull in AngularJS, its common dependencies and write out the boilerplate needed for a basic Controller and any other components the framework may require.


As we understand that it's unlikely a user will wish to manually type out the ":all" part of each generator, we support a catch-"all". If a generator has a sub-generator (grouper) called "all" we will attempt to call "all" when you try running the top-level generator. This allows a user to simply call: As we understand that it's unlikely a user will wish to manually type out the ":all" part of each generator, we support a catch-"all". If a generator has a sub-generator (grouper) called "all" we will attempt to call "all" when you try running the top-level generator. This allows a user to simply call:


{% highlight shell %} {% highlight sh %}
yeoman init angular yeoman init angular
{% endhighlight %} {% endhighlight %}
and has it defer to `angular:all` automatically. and has it defer to `angular:all` automatically.


If one then wishes to create further AngularJS controllers, one can simply call the 'controller' sub-generator as follows: If one then wishes to create further AngularJS controllers, one can simply call the 'controller' sub-generator as follows:


{% highlight shell %} {% highlight sh %}
yeoman init angularjs:controller controllerName yeoman init angularjs:controller controllerName
{% endhighlight %} {% endhighlight %}


where `controllerName` is the name of the Controller you wish to create. where `controllerName` is the name of the Controller you wish to create.


Similarly, a Backbone.js Generator may be used as follows: Similarly, a Backbone.js Generator may be used as follows:


{% highlight shell %} {% highlight sh %}
yeoman init backbone yeoman init backbone
{% endhighlight %} {% endhighlight %}


where the above would result in boilerplate for models, views, collections and a router being written to the current application directory, as well as Backbone.js and its dependencies being pulled in. One could then call the different sub-generators for the Generator as follows: where the above would result in boilerplate for models, views, collections and a router being written to the current application directory, as well as Backbone.js and its dependencies being pulled in. One could then call the different sub-generators for the Generator as follows:


{% highlight shell %} {% highlight sh %}
yeoman init backbone:model modelName yeoman init backbone:model modelName
yeoman init backbone:collection collectionName yeoman init backbone:collection collectionName
yeoman init backbone:view viewName yeoman init backbone:view viewName
Expand All @@ -92,13 +92,13 @@ yeoman init backbone:router routerName


To list out all of the generators currently available locally, you can use the `--help` flag as follows: To list out all of the generators currently available locally, you can use the `--help` flag as follows:


{% highlight shell %} {% highlight sh %}
yeoman init --help yeoman init --help
{% endhighlight %} {% endhighlight %}


This will print out a list of existing generators, including some of the below: This will print out a list of existing generators, including some of the below:


{% highlight shell %} {% highlight sh %}
Please choose a generator below. Please choose a generator below.


Yeoman: Yeoman:
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/commands/install.md
Expand Up @@ -10,7 +10,7 @@ Running yeoman install packageName will install the dependencies in your project


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman install jquery yeoman install jquery
yeoman install jquery spine yeoman install jquery spine
{% endhighlight %} {% endhighlight %}
Expand All @@ -19,15 +19,15 @@ If installing a dependency which has its own dependencies described, these depen


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman install backbone yeoman install backbone
{% endhighlight %} {% endhighlight %}


will actually also install Underscore.js and jQuery.js as these are required for Backbone to function correctly. will actually also install Underscore.js and jQuery.js as these are required for Backbone to function correctly.


`yeoman install` also supports installing packages using more than just the package name. Namely: `yeoman install` also supports installing packages using more than just the package name. Namely:


{% highlight shell %} {% highlight sh %}
bower install jquery bower install jquery
bower install git://github.com/maccman/package-jquery.git bower install git://github.com/maccman/package-jquery.git
bower install http://code.jquery.com/jquery-1.7.2.js bower install http://code.jquery.com/jquery-1.7.2.js
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/list.md
Expand Up @@ -8,7 +8,7 @@ Lists all of the packages that have been installed using `yeoman install` (Bower


Example: Example:


{% highlight shell %} {% highlight sh %}
# If you have previously called # If you have previously called
yeoman install backbone yeoman install backbone


Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/search.md
Expand Up @@ -8,7 +8,7 @@ Searches the Bower registry for packages which include a specific keyword in the


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman search jquery yeoman search jquery


# outputs # outputs
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/test.md
Expand Up @@ -14,7 +14,7 @@ gets called when running `yeoman build`.


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman test yeoman test


# outputs: # outputs:
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/commands/uninstall.md
Expand Up @@ -7,7 +7,7 @@ Removes the package `packageName` from the current project.


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman uninstall backbone yeoman uninstall backbone


# outputs: # outputs:
Expand All @@ -20,7 +20,7 @@ will throw an error.


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman uninstall jquery yeoman uninstall jquery


# outputs: # outputs:
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/commands/update.md
Expand Up @@ -8,7 +8,7 @@ Updates an already installed package `packageName` to the latest version availab


Example: Example:


{% highlight shell %} {% highlight sh %}
yeoman update jquery yeoman update jquery


# outputs # outputs
Expand Down
12 changes: 6 additions & 6 deletions docs/cli/package_manager.md
Expand Up @@ -19,7 +19,7 @@ In Bower, dependencies are listed in a ‘component.json’ file, similar to Nod


Dependencies are then installed locally via the `yeoman install’ command. First they're resolved to find conflicts, then downloaded and unpacked in a local sub dir called components: Dependencies are then installed locally via the `yeoman install’ command. First they're resolved to find conflicts, then downloaded and unpacked in a local sub dir called components:


{% highlight shell %} {% highlight sh %}
/component.json /component.json
/components/modernizr/index.js /components/modernizr/index.js
/components/modernizr/modernizr.js /components/modernizr/modernizr.js
Expand All @@ -35,33 +35,33 @@ This approach has a number of benefits.


The easiest approach is to use a Bower package statically is to then just reference the package manually from a script tag: The easiest approach is to use a Bower package statically is to then just reference the package manually from a script tag:


{% highlight shell %} {% highlight sh %}
<script src="components/modernizr/modernizr.js"></script> <script src="components/modernizr/modernizr.js"></script>
{% endhighlight %} {% endhighlight %}


Similar to NPM, our Bower integration also allows users to easily search for and update packages easily. e.g Similar to NPM, our Bower integration also allows users to easily search for and update packages easily. e.g


To search for a package: To search for a package:


{% highlight shell %} {% highlight sh %}
yeoman search jquery yeoman search jquery
{% endhighlight %} {% endhighlight %}


To install a package: To install a package:


{% highlight shell %} {% highlight sh %}
yeoman install jquery yeoman install jquery
{% endhighlight %} {% endhighlight %}


To update a package, you need to reference it by name: To update a package, you need to reference it by name:


{% highlight shell %} {% highlight sh %}
yeoman update jquery yeoman update jquery
{% endhighlight %} {% endhighlight %}


To list installed packages: To list installed packages:


{% highlight shell %} {% highlight sh %}
yeoman list yeoman list
{% endhighlight %} {% endhighlight %}


Expand Down

0 comments on commit f61ccb1

Please sign in to comment.