From f61ccb1721b9d69f16a512b49aadeba8ab14010d Mon Sep 17 00:00:00 2001 From: "Eric J. Duran" Date: Mon, 10 Sep 2012 20:27:37 -0400 Subject: [PATCH] Replacing shell with sh so github can parse it correctly --- docs/cli/commands/help.md | 2 +- docs/cli/commands/init.md | 20 ++++++++++---------- docs/cli/commands/install.md | 6 +++--- docs/cli/commands/list.md | 2 +- docs/cli/commands/search.md | 2 +- docs/cli/commands/test.md | 2 +- docs/cli/commands/uninstall.md | 4 ++-- docs/cli/commands/update.md | 2 +- docs/cli/package_manager.md | 12 ++++++------ 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/cli/commands/help.md b/docs/cli/commands/help.md index f78a0ad1..9e829dea 100644 --- a/docs/cli/commands/help.md +++ b/docs/cli/commands/help.md @@ -5,7 +5,7 @@ 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 build # Build an optimized version of your app, ready to deploy yeoman server # Launch a preview server which will begin watching for changes diff --git a/docs/cli/commands/init.md b/docs/cli/commands/init.md index 5ba87843..10cb482b 100644 --- a/docs/cli/commands/init.md +++ b/docs/cli/commands/init.md @@ -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: -{% highlight shell %} +{% highlight sh %} _ .--------------------------. _|o|_ | Welcome to Yeoman, | @@ -40,7 +40,7 @@ Please answer the following: Some of our supported custom generators include: -{% highlight shell %} +{% highlight sh %} yeoman init bbb #backbone boilerplate yeoman init angular #angularjs seed yeoman init ember #ember app based on ember-rails @@ -48,13 +48,13 @@ yeoman init ember #ember app based on ember-rails 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 {% 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: -{% highlight shell %} +{% highlight sh %} yeoman init angular:all {% endhighlight %} @@ -62,14 +62,14 @@ The idea here is that the Generator would pull in AngularJS, its common dependen 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 {% endhighlight %} 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: -{% highlight shell %} +{% highlight sh %} yeoman init angularjs:controller controllerName {% endhighlight %} @@ -77,13 +77,13 @@ where `controllerName` is the name of the Controller you wish to create. Similarly, a Backbone.js Generator may be used as follows: -{% highlight shell %} +{% highlight sh %} yeoman init backbone {% 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: -{% highlight shell %} +{% highlight sh %} yeoman init backbone:model modelName yeoman init backbone:collection collectionName yeoman init backbone:view viewName @@ -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: -{% highlight shell %} +{% highlight sh %} yeoman init --help {% endhighlight %} This will print out a list of existing generators, including some of the below: -{% highlight shell %} +{% highlight sh %} Please choose a generator below. Yeoman: diff --git a/docs/cli/commands/install.md b/docs/cli/commands/install.md index 053b00af..18f299f7 100644 --- a/docs/cli/commands/install.md +++ b/docs/cli/commands/install.md @@ -10,7 +10,7 @@ Running yeoman install packageName will install the dependencies in your project Example: -{% highlight shell %} +{% highlight sh %} yeoman install jquery yeoman install jquery spine {% endhighlight %} @@ -19,7 +19,7 @@ If installing a dependency which has its own dependencies described, these depen Example: -{% highlight shell %} +{% highlight sh %} yeoman install backbone {% endhighlight %} @@ -27,7 +27,7 @@ will actually also install Underscore.js and jQuery.js as these are required for `yeoman install` also supports installing packages using more than just the package name. Namely: -{% highlight shell %} +{% highlight sh %} bower install jquery bower install git://github.com/maccman/package-jquery.git bower install http://code.jquery.com/jquery-1.7.2.js diff --git a/docs/cli/commands/list.md b/docs/cli/commands/list.md index 2de38fb3..679e9c7e 100644 --- a/docs/cli/commands/list.md +++ b/docs/cli/commands/list.md @@ -8,7 +8,7 @@ Lists all of the packages that have been installed using `yeoman install` (Bower Example: -{% highlight shell %} +{% highlight sh %} # If you have previously called yeoman install backbone diff --git a/docs/cli/commands/search.md b/docs/cli/commands/search.md index 16401e5c..e5ddd894 100644 --- a/docs/cli/commands/search.md +++ b/docs/cli/commands/search.md @@ -8,7 +8,7 @@ Searches the Bower registry for packages which include a specific keyword in the Example: -{% highlight shell %} +{% highlight sh %} yeoman search jquery # outputs diff --git a/docs/cli/commands/test.md b/docs/cli/commands/test.md index 87e732f6..8ae1e290 100644 --- a/docs/cli/commands/test.md +++ b/docs/cli/commands/test.md @@ -14,7 +14,7 @@ gets called when running `yeoman build`. Example: -{% highlight shell %} +{% highlight sh %} yeoman test # outputs: diff --git a/docs/cli/commands/uninstall.md b/docs/cli/commands/uninstall.md index ae6ce3d7..e6391e9b 100644 --- a/docs/cli/commands/uninstall.md +++ b/docs/cli/commands/uninstall.md @@ -7,7 +7,7 @@ Removes the package `packageName` from the current project. Example: -{% highlight shell %} +{% highlight sh %} yeoman uninstall backbone # outputs: @@ -20,7 +20,7 @@ will throw an error. Example: -{% highlight shell %} +{% highlight sh %} yeoman uninstall jquery # outputs: diff --git a/docs/cli/commands/update.md b/docs/cli/commands/update.md index c3dff7b8..8dd2dc7f 100644 --- a/docs/cli/commands/update.md +++ b/docs/cli/commands/update.md @@ -8,7 +8,7 @@ Updates an already installed package `packageName` to the latest version availab Example: -{% highlight shell %} +{% highlight sh %} yeoman update jquery # outputs diff --git a/docs/cli/package_manager.md b/docs/cli/package_manager.md index 30e00d4a..bdc2c01c 100644 --- a/docs/cli/package_manager.md +++ b/docs/cli/package_manager.md @@ -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: -{% highlight shell %} +{% highlight sh %} /component.json /components/modernizr/index.js /components/modernizr/modernizr.js @@ -35,7 +35,7 @@ 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: -{% highlight shell %} +{% highlight sh %} <script src="components/modernizr/modernizr.js"></script> {% endhighlight %} @@ -43,25 +43,25 @@ Similar to NPM, our Bower integration also allows users to easily search for and To search for a package: -{% highlight shell %} +{% highlight sh %} yeoman search jquery {% endhighlight %} To install a package: -{% highlight shell %} +{% highlight sh %} yeoman install jquery {% endhighlight %} To update a package, you need to reference it by name: -{% highlight shell %} +{% highlight sh %} yeoman update jquery {% endhighlight %} To list installed packages: -{% highlight shell %} +{% highlight sh %} yeoman list {% endhighlight %}