Skip to content

Commit 32b6340

Browse files
committed
Convert docs to use fenced code blocks again
Since GitHub Pages now supports it: https://github.com/blog/1366-github-pages-updated-to-jekyll-0-12-0
1 parent f5fd21b commit 32b6340

File tree

16 files changed

+236
-287
lines changed

16 files changed

+236
-287
lines changed

docs/cli/commands/build.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
## <a href="#build" name="build">build</a>
42

53
Usage: `yeoman build`, `yeoman build:<target>`
@@ -63,24 +61,21 @@ setup each time.
6361

6462
The following is the relevant block to edit within your Gruntfile:
6563

66-
{% highlight javascript %}
67-
// rjs configuration. You don't necessarily need to specify the typical
68-
// `path` configuration, the rjs task will parse these values from your
69-
// main module, using http://requirejs.org/docs/optimization.html#mainConfigFile
70-
//
71-
// name / out / mainConfig file should be used. You can let it blank if
72-
// you're using usemin-handler to parse rjs config from markup (default
73-
// setup)
74-
rjs: {
75-
// no minification, is done by the min task
76-
optimize: 'none',
77-
baseUrl: './scripts',
78-
wrap: true
79-
}
80-
{% endhighlight %}
64+
```js
65+
// rjs configuration. You don't necessarily need to specify the typical
66+
// `path` configuration, the rjs task will parse these values from your
67+
// main module, using http://requirejs.org/docs/optimization.html#mainConfigFile
68+
//
69+
// name / out / mainConfig file should be used. You can let it blank if
70+
// you're using usemin-handler to parse rjs config from markup (default
71+
// setup)
72+
rjs: {
73+
// no minification, is done by the min task
74+
optimize: 'none',
75+
baseUrl: './scripts',
76+
wrap: true
77+
}
78+
```
8179

8280
See the official project [repo](https://github.com/jrburke/r.js) for more information on the
8381
options supported by r.js.
84-
85-
86-

docs/cli/commands/help.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
21
## <a href="#help" name="help">help</a>
32

43
* `yeoman --help` or `yeoman help`
54

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

8-
{% highlight sh %}
7+
```sh
98
yeoman init # Initialize and scaffold a new project using generator templates
109
yeoman build # Build an optimized version of your app, ready to deploy
1110
yeoman server # Launch a preview server which will begin watching for changes
@@ -17,6 +16,6 @@ yeoman update # Update a package to the latest version
1716
yeoman list # List the packages currently installed
1817
yeoman search # Query the registry for matching package names
1918
yeoman lookup # Look up info on a particular package
20-
{% endhighlight %}
19+
```
2120

2221
Note that commands may also support additional flags and so we recommend consulting the documentation for specific commands for the complete details.

docs/cli/commands/init.md

Lines changed: 22 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ By default we support Compass and CoffeeScript, so if your project includes any
1616

1717
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:
1818

19-
{% highlight sh %}
20-
19+
```sh
2120
_ .--------------------------.
2221
_|o|_ | Welcome to Yeoman, |
2322
|_| | ladies and gentlemen! |
@@ -32,71 +31,60 @@ Out of the box I include HTML5 Boilerplate, jQuery and Modernizr.
3231

3332
Please answer the following:
3433
[?] Would you like to include Twitter Bootstrap for Compass? (Y/n)
35-
{% endhighlight %}
34+
```
3635

3736
### custom generators
3837

3938
Some of our supported custom generators include:
4039

41-
{% highlight sh %}
42-
yeoman init bbb #backbone boilerplate
43-
yeoman init angular #angularjs seed
44-
yeoman init ember #ember app based on ember-rails
45-
{% endhighlight %}
40+
```sh
41+
yeoman init bbb # backbone boilerplate
42+
yeoman init angular # angularjs seed
43+
yeoman init ember # ember app based on ember-rails
44+
```
4645

4746
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:
4847

49-
{% highlight sh %}
50-
yeoman init generatorName #e.g yeoman init angular
51-
{% endhighlight %}
48+
```sh
49+
yeoman init generatorName # e.g yeoman init angular
50+
```
5251

5352
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:
5453

55-
{% highlight sh %}
56-
yeoman init angular:all
57-
{% endhighlight %}
54+
yeoman init angular:all
5855

5956
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.
6057

6158
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:
6259

63-
{% highlight sh %}
64-
yeoman init angular
65-
{% endhighlight %}
60+
yeoman init angular
61+
6662
and has it defer to `angular:all` automatically.
6763

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

70-
{% highlight sh %}
71-
yeoman init angular:controller controllerName
72-
{% endhighlight %}
66+
yeoman init angular:controller controllerName
7367

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

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

78-
{% highlight sh %}
79-
yeoman init backbone
80-
{% endhighlight %}
72+
yeoman init backbone
8173

8274
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:
8375

84-
{% highlight sh %}
85-
yeoman init backbone:model modelName
86-
yeoman init backbone:collection collectionName
87-
yeoman init backbone:view viewName
88-
yeoman init backbone:router routerName
89-
{% endhighlight %}
76+
yeoman init backbone:model modelName
77+
yeoman init backbone:collection collectionName
78+
yeoman init backbone:view viewName
79+
yeoman init backbone:router routerName
9080

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

93-
{% highlight sh %}
94-
yeoman init --help
95-
{% endhighlight %}
83+
yeoman init --help
9684

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

99-
{% highlight sh %}
87+
```sh
10088
Please choose a generator below.
10189

10290
Yeoman:
@@ -115,4 +103,4 @@ Backbone:
115103
backbone:router
116104
backbone:view
117105
backbone:collection
118-
{% endhighlight %}
106+
```

docs/cli/commands/install.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,41 @@ By default, running `yeoman install packageName` will install the dependency in
88

99
Example:
1010

11-
{% highlight sh %}
11+
```sh
1212
yeoman install backbone
1313

1414
# or if you wish to install multiple packages at once..
1515
yeoman install jquery spine
16-
{% endhighlight %}
16+
```
1717

1818
As mentioned, the files for these dependencies will be added to `app/components`. If you wish to use any of them you will need to manually include a script/file reference to the relevant source files.
1919

2020
Example:
2121

22-
{% highlight html %}
22+
```html
2323
<script src="components/spine/lib/spine.js"></script>
24-
{% endhighlight %}
24+
```
2525

2626
If installing a dependency which has its own dependencies described, these dependencies will also be pulled in.
2727

2828
Example:
2929

30-
{% highlight sh %}
31-
yeoman install backbone
32-
{% endhighlight %}
30+
yeoman install backbone
3331

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

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

38-
{% highlight sh %}
39-
yeoman install jquery
40-
yeoman install git://github.com/components/jquery.git
41-
yeoman install components/jquery (same as above)
42-
yeoman install http://foo.com/jquery.awesome-plugin.js
43-
yeoman install ./repos/jquery
44-
{% endhighlight %}
36+
yeoman install jquery
37+
yeoman install git://github.com/components/jquery.git
38+
yeoman install components/jquery (same as above)
39+
yeoman install http://foo.com/jquery.awesome-plugin.js
40+
yeoman install ./repos/jquery
4541

4642
As you can see, packages can be installed by name, Git endpoint, GitHub shorthand, URL or local path. If you install and URL that is a zip or tar file, yeoman will automatically extract the contents of it. When tags are available in the endpoint, you can specify a semver tag to fetch concrete versions:
4743

48-
{% highlight sh %}
49-
yeoman install jquery#1.8.1
50-
yeoman install git://github.com/components/jquery.git#~1.8.1
51-
yeoman install components/jquery#1.8.x
52-
{% endhighlight %}
44+
yeoman install jquery#1.8.1
45+
yeoman install git://github.com/components/jquery.git#~1.8.1
46+
yeoman install components/jquery#1.8.x
5347

5448
More in the [Bower docs](https://github.com/twitter/bower/blob/master/README.md#usage)

docs/cli/commands/list.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
## <a href="#list" name="list">list</a>
42

53
Usage: `yeoman list`
@@ -8,7 +6,7 @@ Lists all of the packages that have been installed using `yeoman install` (Bower
86

97
Example:
108

11-
{% highlight sh %}
9+
```sh
1210
# If you have previously called
1311
yeoman install backbone
1412

@@ -23,6 +21,6 @@ yeoman list
2321
│ └── underscore#1.3.3
2422
├── jquery#1.7.2
2523
└── underscore#1.3.3
26-
{% endhighlight %}
24+
```
2725

2826
As you can see, this also includes the version information for each package and its dependencies.

docs/cli/commands/lookup.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
## <a href="#lookup" name="lookup">lookup</a>
42

53
Usage: `yeoman lookup <packageName>`
@@ -8,10 +6,10 @@ Performs a lookup in the Bower registry for a package of a specific name. One wo
86

97
Example:
108

11-
{% highlight sh %}
9+
```sh
1210
yeoman lookup jquery
1311

1412
# outputs
1513

1614
jquery git://github.com/maccman/package-jquery.git
17-
{% endhighlight %}
15+
```

docs/cli/commands/search.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
## <a href="#search" name="search">search</a>
42

53
Usage: `yeoman search <keyword>`
@@ -8,7 +6,7 @@ Searches the Bower registry for packages which include a specific keyword in the
86

97
Example:
108

11-
{% highlight sh %}
9+
```sh
1210
yeoman search jquery
1311

1412
# outputs
@@ -18,5 +16,4 @@ Search results:
1816
- jquery git://github.com/maccman/package-jquery.git
1917
- jquery-ui git://github.com/maccman/package-jquery-ui.git
2018
- jquery-infinite-scroll git://github.com/paulirish/infinite-scroll.git
21-
22-
{% endhighlight %}
19+
```

docs/cli/commands/server.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
## <a href="#server" name="server">server</a>
42

53
Usage: `yeoman server`

docs/cli/commands/test.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
## <a href="#test" name="test">test</a>
42

53
Usage: `yeoman test`
@@ -18,7 +16,7 @@ launched to serve file for PhantomJS.
1816

1917
Example:
2018

21-
{% highlight sh %}
19+
```sh
2220
yeoman test
2321

2422
# outputs:
@@ -29,4 +27,4 @@ Running specs for index.html
2927
>> 82 assertions passed in 53 specs (562ms)
3028

3129
Done, without errors.
32-
{% endhighlight %}
30+
```

docs/cli/commands/uninstall.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
## <a href="#uninstall" name="uninstall">uninstall</a>
32

43
Usage: yeoman uninstall packageName
@@ -7,24 +6,23 @@ Removes the package `packageName` from the current project.
76

87
Example:
98

10-
{% highlight sh %}
9+
```sh
1110
yeoman uninstall backbone
1211

1312
# outputs:
1413

1514
bower uninstalling /project/components/backbone
16-
{% endhighlight %}
15+
```
1716

18-
Note: If you attempt to uninstall a package that is a dependency of other packages, yeoman (via Bower)
19-
will throw an error.
17+
Note: If you attempt to uninstall a package that is a dependency of other packages, yeoman (via Bower) will throw an error.
2018

2119
Example:
2220

23-
{% highlight sh %}
21+
```sh
2422
yeoman uninstall jquery
2523

2624
# outputs:
2725
warning backbone depends on jquery
28-
{% endhighlight %}
26+
```
2927

3028
This simply means that you should uninstall backbone (the top-level package with the dependency) if you wish to remove all traces of the jquery package.

0 commit comments

Comments
 (0)