Hopiu/angular.js
1
0
Fork 0
mirror of https://github.com/Hopiu/angular.js.git synced 2026-03-18 07:50:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
angular.js/docs/content/guide/index.ngdoc

144 lines
11 KiB
Text
Raw Normal View History

Added part of guide documentation and supporting changes to doc generator
2011-01-26 05:55:11 +00:00
@ngdoc overview
@name Developer Guide
@description
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
# Guide to AngularJS Documentation
new batch of docs
2011-06-06 15:50:35 +00:00
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
Everything you need to know about AngularJS
docs(guide/overview): Refactor overview and mvc docs Before, there we multiple overview docs: - guide/overview - guide/introduction - guide/dev_guide.mvc - guide/dev_guide.mvc.understanding_model - guide/dev_guide.mvc.understanding_view - guide/concepts Now we have: - guide/introduction: High level description of Angular with the key benefits but without code or any concrete concepts - guide/concepts: explains all important concepts with a simple example and contains deep links to the other parts of the guide. All the old information was moved into existing documents or deleted when they were duplicates.
2013-11-06 06:16:11 +00:00
* {@link guide/introduction What is AngularJS?}
* {@link guide/concepts Conceptual Overview}
## Tutorials
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
* {@link tutorial/index Official AngularJS Tutorial}
* [10 Reasons Why You Should Use AngularJS](http://www.sitepoint.com/10-reasons-use-angularjs/)
* [Design Principles of AngularJS (video)](https://www.youtube.com/watch?v=HCR7i5F5L8c)
* [Fundamentals in 60 Minutes (video)](http://www.youtube.com/watch?v=i9MHigUZKEM)
* [For folks with jQuery background](http://stackoverflow.com/questions/14994391/how-do-i-think-in-angularjs-if-i-have-a-jquery-background)
## Core Concepts
### Templates
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.
docs(guide/overview): Refactor overview and mvc docs Before, there we multiple overview docs: - guide/overview - guide/introduction - guide/dev_guide.mvc - guide/dev_guide.mvc.understanding_model - guide/dev_guide.mvc.understanding_view - guide/concepts Now we have: - guide/introduction: High level description of Angular with the key benefits but without code or any concrete concepts - guide/concepts: explains all important concepts with a simple example and contains deep links to the other parts of the guide. All the old information was moved into existing documents or deleted when they were duplicates.
2013-11-06 06:16:11 +00:00
* {@link guide/databinding Data binding}
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
* {@link guide/expression Expressions}
* {@link guide/directive Directives}
* {@link api/ngRoute.$route Views and routes (see the example)}
docs(guide/filter): Refactor filter guide docs This refactors the filter guide docs into a single file. Also removes out of date references to the fact that Angular used to enhance Arrays while evaluating expressions.
2013-11-07 22:14:57 +00:00
* {@link guide/filter Filters}
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
* {@link guide/forms Forms} and [Concepts of AngularJS Forms](http://mrbool.com/the-concepts-of-angularjs-forms/29117)
### Application Structure
* **Blog post: **[When to use directives, controllers or services](http://kirkbushell.me/when-to-use-directives-controllers-or-services-in-angular/)
* **App wiring:** {@link guide/di Dependency injection}
* **Exposing model to templates:** {@link guide/scope Scopes}
* **Communicating with servers:** {@link api/ng.$http $http}, {@link api/ngResource.$resource $resource}
### Other AngularJS Features
* **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)
* **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)
* **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/)
* **Mobile:** {@link api/ngTouch Touch events}
### Testing
* **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/)
* **Scenario testing:** [Protractor](https://github.com/angular/protractor)
## Specific Topics
* **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/)
* **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/)
* **Other Languages:** [CoffeeScript](http://www.coffeescriptlove.com/2013/08/angularjs-and-coffeescript-tutorials.html), [Dart](https://github.com/angular/angular.dart.tutorial/wiki)
* **Realtime: **[Socket.io](http://www.creativebloq.com/javascript/angularjs-collaboration-board-socketio-2132885), [OmniBinder](https://github.com/jeffbcross/omnibinder)
* **Visualization:** [SVG](http://gaslight.co/blog/angular-backed-svgs), [D3.js](http://www.ng-newsletter.com/posts/d3-on-angular.html)
## Tools
* **Debugging:** [Batarang](https://chrome.google.com/webstore/detail/angularjs-batarang/ighdmehidhipcmcojjgiloacoafjmpfk?hl=en)
* **Testing:** [Karma](http://karma-runner.github.io), [Protractor](https://github.com/angular/protractor)
* **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)
* **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/)
docs(guide): fix typo Closes #4821
2013-11-07 16:52:30 +00:00
## Complementary Libraries
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
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/).
* **Internationalization:** [angular-translate](http://pascalprecht.github.io/angular-translate/), [angular-gettext](http://angular-gettext.rocketeer.be/)
* **RESTful services:** [Restangular](https://github.com/mgonto/restangular)
* **SQL and NoSQL backends:** [BreezeJS](http://www.breezejs.com/), [AngularFire](http://angularfire.com/)
* **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/)
## Deployment
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.
2013-12-03 00:11:26 +00:00
### General
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
* **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)
* **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)
docs(guide): add SEO4Ajax to the SEO tools list Closes #4748
2013-11-01 14:09:29 +00:00
* **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/)
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
### Server-Specific
* **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)
* **FireBase:** [AngularFire](http://angularfire.com/), [Realtime Apps with AngularJS and FireBase (video)](http://www.youtube.com/watch?v=C7ZI7z7qnHU)
* **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)
* **Hood.ie:** [60 Minutes to Awesome](http://www.roberthorvick.com/2013/06/30/todomvc-angularjs-hood-ie-60-minutes-to-awesome/)
* **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)
* **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)
* **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)
## Learning Resources
docs(guide): improve links to books Nested bullet points don't appear very nicely so resorted to nested heading for the Learning Resources and in particular Books sections. Closes #4677
2013-10-28 20:57:43 +00:00
###Books
* [AngularJS](http://www.amazon.com/AngularJS-Brad-Green/dp/1449344852) by Brad Green and Shyam Seshadri
* [Mastering Web App Development](http://www.amazon.com/Mastering-Web-Application-Development-AngularJS/dp/1782161821) by Pawel Kozlowski and Pete Bacon Darwin
* [AngularJS Directives](http://www.amazon.com/AngularJS-Directives-Alex-Vanston/dp/1783280336) by Alex Vanston
* [Recipes With AngularJS](http://www.amazon.co.uk/Recipes-Angular-js-Frederik-Dietz-ebook/dp/B00DK95V48) by Frederik Dietz
* [Developing an AngularJS Edge](http://www.amazon.com/Developing-AngularJS-Edge-Christopher-Hiller-ebook/dp/B00CJLFF8K) by Christopher Hiller
docs(guide): add ng-book link to books Closes #4792
2013-11-05 21:01:03 +00:00
* [ng-book: The Complete Book on AngularJS](http://ng-book.com/) by Ari Lerner
docs(guide): improve links to books Nested bullet points don't appear very nicely so resorted to nested heading for the Learning Resources and in particular Books sections. Closes #4677
2013-10-28 20:57:43 +00:00
###Videos:
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.
2013-12-03 00:11:26 +00:00
* [egghead.io](http://egghead.io/)
docs(guide): improve links to books Nested bullet points don't appear very nicely so resorted to nested heading for the Learning Resources and in particular Books sections. Closes #4677
2013-10-28 20:57:43 +00:00
* [Angular on YouTube](http://youtube.com/angularjs)
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.
2013-12-03 00:11:26 +00:00
### Courses
* **Free online:**
docs(guide): improve links to books Nested bullet points don't appear very nicely so resorted to nested heading for the Learning Resources and in particular Books sections. Closes #4677
2013-10-28 20:57:43 +00:00
[thinkster.io](http://thinkster.io),
[CodeAcademy](http://www.codecademy.com/courses/javascript-advanced-en-2hJ3J/0/1)
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.
2013-12-03 00:11:26 +00:00
* **Paid online:**
docs(guide): improve links to books Nested bullet points don't appear very nicely so resorted to nested heading for the Learning Resources and in particular Books sections. Closes #4677
2013-10-28 20:57:43 +00:00
[Pluralsite (3 courses)](http://www.pluralsight.com/training/Courses/Find?highlight=true&searchTerm=angularjs),
[Tuts+](https://tutsplus.com/course/easier-js-apps-with-angular/),
[lynda.com](http://www.lynda.com/AngularJS-tutorials/Up-Running-AngularJS/133318-2.html)
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.
2013-12-03 00:11:26 +00:00
* **Paid onsite:**
docs(guide): improve links to books Nested bullet points don't appear very nicely so resorted to nested heading for the Learning Resources and in particular Books sections. Closes #4677
2013-10-28 20:57:43 +00:00
[angularbootcamp.com](http://angularbootcamp.com/)
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
## Getting Help
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:
* [Stackoverflow.com](http://stackoverflow.com/search?q=angularjs)
* [AngularJS mailing list](https://groups.google.com/forum/#!forum/angular)
* [AngularJS IRC channel](http://webchat.freenode.net/?channels=angularjs&uio=d4)
## Social Channels
* **Daily updates:** [Google+](https://plus.google.com/u/0/+AngularJS) or [Twitter](https://twitter.com/angularjs)
docs(guide): add ng-newsletter to weekly updates link Closes #4793
2013-11-05 21:02:23 +00:00
* **Weekly newsletter:** [ng-newsletter](http://www.ng-newsletter.com/)
docs(guide): rewrite guide landing page Change landing page to include a set of curated links with subject headings as a guide through Angular's docs and other resources. Closes #4470
2013-10-16 20:37:06 +00:00
* **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)
* **Official news and releases: **[AngularJS Blog](http://blog.angularjs.org/)
## Contributing to AngularJS
Though we have a core group of core contributors at Google, Angular is an open source project with hundreds of contributors. We'd love you to be one of them. When you're ready, please read the {@link misc/contribute Guide for contributing to AngularJS}.
## Final Bits
Didn't find what you're looking for here? Check out [AngularJS-Learning](https://github.com/jmcunningham/AngularJS-Learning) for an even more comprehensive list of links to videos, tutorials, and blog posts.
If you have awesome AngularJS resources that belong on this page, please tell us about them on [Google+](https://plus.google.com/u/0/+AngularJS) or [Twitter](https://twitter.com/angularjs).
new batch of docs
2011-06-06 15:50:35 +00:00
Reference in a new issue Copy permalink