Skip to content

Commit 8ec2743

Browse files
Andy Ferranaomiblack
Andy Ferra
authored andcommitted
docs(design): guide index formatting
Just my first pass at a more readable format of the guide index. Note: the styles apply to all content in the docs, not just the guide index. This is intentional and I feel that the result is positive.
1 parent ecbee81 commit 8ec2743

File tree

2 files changed

+27
-46
lines changed

2 files changed

+27
-46
lines changed

docs/content/guide/index.ngdoc

Lines changed: 6 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,14 @@
77
Everything you need to know about AngularJS
88

99
* {@link guide/introduction What is AngularJS?}
10-
1110
* {@link guide/concepts Conceptual Overview}
1211

1312
## Tutorials
1413

1514
* {@link tutorial/index Official AngularJS Tutorial}
16-
1715
* [10 Reasons Why You Should Use AngularJS](http://www.sitepoint.com/10-reasons-use-angularjs/)
18-
1916
* [Design Principles of AngularJS (video)](https://www.youtube.com/watch?v=HCR7i5F5L8c)
20-
2117
* [Fundamentals in 60 Minutes (video)](http://www.youtube.com/watch?v=i9MHigUZKEM)
22-
2318
* [For folks with jQuery background](http://stackoverflow.com/questions/14994391/how-do-i-think-in-angularjs-if-i-have-a-jquery-background)
2419

2520
## Core Concepts
@@ -29,101 +24,71 @@ Everything you need to know about AngularJS
2924
In Angular applications, you move the job of filling page templates with data from the server to the client. The result is a system better structured for dynamic page updates. Below are the core features you'll use.
3025

3126
* {@link guide/databinding Data binding}
32-
3327
* {@link guide/expression Expressions}
34-
3528
* {@link guide/directive Directives}
36-
3729
* {@link api/ngRoute.$route Views and routes (see the example)}
38-
3930
* {@link guide/filter Filters}
40-
4131
* {@link guide/forms Forms} and [Concepts of AngularJS Forms](http://mrbool.com/the-concepts-of-angularjs-forms/29117)
4232

4333
### Application Structure
4434

4535
* **Blog post: **[When to use directives, controllers or services](http://kirkbushell.me/when-to-use-directives-controllers-or-services-in-angular/)
46-
4736
* **App wiring:** {@link guide/di Dependency injection}
48-
4937
* **Exposing model to templates:** {@link guide/scope Scopes}
50-
5138
* **Communicating with servers:** {@link api/ng.$http $http}, {@link api/ngResource.$resource $resource}
5239

5340
### Other AngularJS Features
5441

5542
* **Animation:** {@link guide/animations Core concepts}, {@link api/ngAnimate ngAnimate API}, and [Animation in AngularJS 1.2](http://www.yearofmoo.com/2013/08/remastered-animation-in-angularjs-1-2.html)
56-
5743
* **Security:** {@link api/ng.$sce Strict Contextual Escaping}, {@link api/ng.directive:ngCsp Content Security Policy}, {@link api/ngSanitize.$sanitize $sanitize}, [video](https://www.youtube.com/watch?v=18ifoT-Id54)
58-
5944
* **Internationalization and Localization:** {@link guide/i18n Angular Guide to i18n and l10n}, {@link api/ng.filter:date date filter}, {@link api/ng.filter:currency currency filter}, [Creating multilingual support](http://www.novanet.no/blog/hallstein-brotan/dates/2013/10/creating-multilingual-support-using-angularjs/)
60-
6145
* **Mobile:** {@link api/ngTouch Touch events}
6246

6347
### Testing
6448

6549
* **Unit testing:** [Using Karma (video)](http://www.youtube.com/watch?v=YG5DEzaQBIc), {@link guide/dev_guide.unit-testing Unit testing}, {@link guide/dev_guide.services.testing_services Testing services}, [Karma in Webstorm](http://blog.jetbrains.com/webstorm/2013/10/running-javascript-tests-with-karma-in-webstorm-7/)
66-
6750
* **Scenario testing:** [Protractor](https://github.com/angular/protractor)
6851

6952
## Specific Topics
7053

7154
* **Login: **[Google example](https://developers.google.com/+/photohunt/python), [Facebook example](http://blog.brunoscopelliti.com/facebook-authentication-in-your-angularjs-web-app), [authentication strategy](http://blog.brunoscopelliti.com/deal-with-users-authentication-in-an-angularjs-web-app), [unix-style authorization](http://frederiknakstad.com/authentication-in-single-page-applications-with-angular-js/)
72-
7355
* **Mobile:** [Angular on Mobile Guide](http://www.ng-newsletter.com/posts/angular-on-mobile.html), [PhoneGap](http://devgirl.org/2013/06/10/quick-start-guide-phonegap-and-angularjs/)
74-
7556
* **Other Languages:** [CoffeeScript](http://www.coffeescriptlove.com/2013/08/angularjs-and-coffeescript-tutorials.html), [Dart](https://github.com/angular/angular.dart.tutorial/wiki)
76-
7757
* **Realtime: **[Socket.io](http://www.creativebloq.com/javascript/angularjs-collaboration-board-socketio-2132885), [OmniBinder](https://github.com/jeffbcross/omnibinder)
78-
7958
* **Visualization:** [SVG](http://gaslight.co/blog/angular-backed-svgs), [D3.js](http://www.ng-newsletter.com/posts/d3-on-angular.html)
8059

8160
## Tools
8261

8362
* **Debugging:** [Batarang](https://chrome.google.com/webstore/detail/angularjs-batarang/ighdmehidhipcmcojjgiloacoafjmpfk?hl=en)
84-
8563
* **Testing:** [Karma](http://karma-runner.github.io), [Protractor](https://github.com/angular/protractor)
86-
8764
* **Editor support:** [Webstorm](http://plugins.jetbrains.com/plugin/6971) (and [video](http://www.youtube.com/watch?v=LJOyrSh1kDU)), [Sublime Text](https://github.com/angular-ui/AngularJS-sublime-package), [Visual Studio](http://madskristensen.net/post/angularjs-intellisense-in-visual-studio-2012)
88-
8965
* **Workflow:** [Yeoman.io](https://github.com/yeoman/generator-angular) and [Angular Yeoman Tutorial](http://www.sitepoint.com/kickstart-your-angularjs-development-with-yeoman-grunt-and-bower/)
9066

9167
## Complementary Libraries
9268

9369
This is a short list of libraries with specific support and documentation for working with Angular. You can find a full list of all known Angular external libraries at [ngmodules.org](http://ngmodules.org/).
9470

9571
* **Internationalization:** [angular-translate](http://pascalprecht.github.io/angular-translate/), [angular-gettext](http://angular-gettext.rocketeer.be/)
96-
9772
* **RESTful services:** [Restangular](https://github.com/mgonto/restangular)
98-
9973
* **SQL and NoSQL backends:** [BreezeJS](http://www.breezejs.com/), [AngularFire](http://angularfire.com/)
100-
10174
* **UI Widgets: **[KendoUI](http://kendo-labs.github.io/angular-kendo/#/), [UI Bootstrap](http://angular-ui.github.io/bootstrap/), [Wijmo](http://wijmo.com/tag/angularjs-2/)
10275

10376
## Deployment
10477

105-
### General
78+
### General
10679

10780
* **Javascript minification: **[Background](http://thegreenpizza.github.io/2013/05/25/building-minification-safe-angular.js-applications/), [ngmin automation tool](http://www.thinkster.io/pick/XlWneEZCqY/angularjs-ngmin)
108-
10981
* **Tracking:** [Angularyitcs (Google Analytics)](http://ngmodules.org/modules/angularytics), [Logging Client-Side Errors](http://www.bennadel.com/blog/2542-Logging-Client-Side-Errors-With-AngularJS-And-Stacktrace-js.htm)
110-
11182
* **SEO:** [By hand](http://www.yearofmoo.com/2012/11/angularjs-and-seo.html), [prerender.io](http://prerender.io/), [Brombone](http://www.brombone.com/), [SEO.js](http://getseojs.com/), [SEO4Ajax](http://www.seo4ajax.com/)
11283

11384
### Server-Specific
11485

11586
* **Django:** [Tutorial](http://blog.mourafiq.com/post/55034504632/end-to-end-web-app-with-django-rest-framework), [Integrating AngularJS with Django](http://django-angular.readthedocs.org/en/latest/integration.html)
116-
11787
* **FireBase:** [AngularFire](http://angularfire.com/), [Realtime Apps with AngularJS and FireBase (video)](http://www.youtube.com/watch?v=C7ZI7z7qnHU)
118-
11988
* **Google Cloud Platform: **[with Cloud Endpoints](https://cloud.google.com/resources/articles/angularjs-cloud-endpoints-recipe-for-building-modern-web-applications), [with Go](https://github.com/GoogleCloudPlatform/appengine-angular-gotodos)
120-
12189
* **Hood.ie:** [60 Minutes to Awesome](http://www.roberthorvick.com/2013/06/30/todomvc-angularjs-hood-ie-60-minutes-to-awesome/)
122-
12390
* **MEAN Stack: **[Blog post](http://blog.mongodb.org/post/49262866911/the-mean-stack-mongodb-expressjs-angularjs-and), [Setup](http://thecodebarbarian.wordpress.com/2013/07/22/introduction-to-the-mean-stack-part-one-setting-up-your-tools/), [GDL Video](https://developers.google.com/live/shows/913996610)
124-
12591
* **Rails: **[Tutorial](http://coderberry.me/blog/2013/04/22/angularjs-on-rails-4-part-1/), [AngularJS with Rails4](https://shellycloud.com/blog/2013/10/how-to-integrate-angularjs-with-rails-4), [angularjs-rails](https://github.com/hiravgandhi/angularjs-rails)
126-
12792
* **PHP: **[Building a RESTful web service](http://blog.brunoscopelliti.com/building-a-restful-web-service-with-angularjs-and-php-more-power-with-resource), [End to End with Laravel 4 (video)](http://www.youtube.com/watch?v=hqAyiqUs93c)
12893

12994
## Learning Resources
@@ -137,38 +102,33 @@ This is a short list of libraries with specific support and documentation for wo
137102
* [ng-book: The Complete Book on AngularJS](http://ng-book.com/) by Ari Lerner
138103

139104
###Videos:
140-
* [egghead.io](http://egghead.io/),
105+
* [egghead.io](http://egghead.io/)
141106
* [Angular on YouTube](http://youtube.com/angularjs)
142107

143-
###Courses
144-
* **Free on-line:**
108+
### Courses
109+
* **Free online:**
145110
[thinkster.io](http://thinkster.io),
146111
[CodeAcademy](http://www.codecademy.com/courses/javascript-advanced-en-2hJ3J/0/1)
147-
* **Paid on-line:**
112+
* **Paid online:**
148113
[Pluralsite (3 courses)](http://www.pluralsight.com/training/Courses/Find?highlight=true&searchTerm=angularjs),
149114
[Tuts+](https://tutsplus.com/course/easier-js-apps-with-angular/),
150115
[lynda.com](http://www.lynda.com/AngularJS-tutorials/Up-Running-AngularJS/133318-2.html)
151-
* **Paid on-site:**
116+
* **Paid onsite:**
152117
[angularbootcamp.com](http://angularbootcamp.com/)
153118

154119
## Getting Help
155120

156121
The recipe for getting help on your unique issue is to create an example that could work (even if it doesn't) in a shareable example on [Plunker](http://plnkr.co/), [JSFiddle](http://jsfiddle.net/), or similar site and then post to one of the following:
157122

158123
* [Stackoverflow.com](http://stackoverflow.com/search?q=angularjs)
159-
160124
* [AngularJS mailing list](https://groups.google.com/forum/#!forum/angular)
161-
162125
* [AngularJS IRC channel](http://webchat.freenode.net/?channels=angularjs&uio=d4)
163126

164127
## Social Channels
165128

166129
* **Daily updates:** [Google+](https://plus.google.com/u/0/+AngularJS) or [Twitter](https://twitter.com/angularjs)
167-
168130
* **Weekly newsletter:** [ng-newsletter](http://www.ng-newsletter.com/)
169-
170131
* **Meetups: **[meetup.com](http://www.meetup.com/find/?keywords=angularJS&radius=Infinity&userFreeform=San+Francisco%2C+CA&mcId=z94108&mcName=San+Francisco%2C+CA&sort=member_count&eventFilter=mysugg)
171-
172132
* **Official news and releases: **[AngularJS Blog](http://blog.angularjs.org/)
173133

174134
## Contributing to AngularJS

docs/src/templates/css/docs.css

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,27 @@
144144
.content h4,
145145
.content h5 {
146146
margin-top: 1em;
147+
letter-spacing: -0.06em;
148+
}
149+
150+
.content h2 {
151+
font-size: 36px;
152+
margin-bottom: .5em;
153+
}
154+
155+
.content h3 {
156+
font-size: 24px;
157+
border-top: 1px solid #eee;
158+
padding-top: .5em;
159+
}
160+
161+
.content h4 {
162+
font-size: 16px;
163+
margin-top: 1.5em;
164+
}
165+
166+
.content ul {
167+
margin-top: .5em;
147168
}
148169

149170
ul.parameters > li > p,

0 commit comments

Comments
 (0)