Skip to content

Commit 34cdbe7

Browse files
committed
Merge pull request nikhilmodak#69 from tmcgee123/master
docs(README): make examples use code markdown to prevent example URL …
2 parents 315103a + ffab6f3 commit 34cdbe7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ gulp.task('ngdocs', [], function () {
3939
});
4040
```
4141

42-
To use a different angularjs version pass `angular` and `angular-animate` files in scripts.
42+
To use a different AngularJS version pass `angular` and `angular-animate` files in scripts.
4343

4444
```js
4545
gulp.task('ngdocs', [], function () {
@@ -75,7 +75,7 @@ If you would like to divide your documentation into different sections, use `gul
7575
```js
7676
gulp.task('ngdocs', [], function () {
7777
var gulpDocs = require('gulp-ngdocs');
78-
var options = {
78+
var options = {
7979
//options
8080
}
8181
return gulpDocs.sections({
@@ -104,7 +104,7 @@ A doc comment looks like this:
104104
* @description
105105
* Resize textarea automatically to the size of its text content.
106106
*
107-
* **Note:** ie<9 needs pollyfill for window.getComputedStyle
107+
* **Note:** ie<9 needs polyfill for window.getComputedStyle
108108
*
109109
* @example
110110
<example module="rfx">
@@ -125,13 +125,13 @@ or take a look at the [AngularJS source code](https://github.com/angular/angular
125125
##Options
126126

127127
####scripts
128-
Set addional custom js files are loaded to the app. This allows the live examples to use custom directives, services, etc. The documentation app works with angular.js 1.2+ and 1.3+. If you include your own angular.js include angular-animate.js too.
128+
Set additional custom JS files are loaded to the app. This allows the live examples to use custom directives, services, etc. The documentation app works with AngularJS 1.2+ and 1.3+. If you include a different version of AngularJS, make sure to include angular-animate.js as well.
129129

130130
Possible values:
131131

132-
- ['path/to/file.js'] file will be copied into the docs, into a `js` folder
133-
- ['http://example.com/file.js', 'https://example.com/file.js', '//example.com/file.js'] reference remote files (eg from a CDN)
134-
- ['../app.js'] reference file relative to the dest folder
132+
- `['path/to/file.js']` file will be copied into the docs, into a `js` folder
133+
- `['http://example.com/file.js', 'https://example.com/file.js', '//example.com/file.js']` reference remote files (eg from a CDN)
134+
- `['../app.js']` reference file relative to the dest folder
135135

136136
####styles
137137
[default] `[]`

0 commit comments

Comments
 (0)