Go to file

Foxandxss b2f2fb87ec docs(toh): make a few corrections closes #967		2016-03-17 21:09:54 -07:00
.vscode	chore: point VS Code to the examples's local version of typescript	2016-02-25 14:47:57 -08:00
public	docs(toh): make a few corrections	2016-03-17 21:09:54 -07:00
tools	chore: update es6-shim to v.0.35.0 per A2 issue #7618	2016-03-15 11:45:39 -07:00
.gitignore	chore: add gulp link-checker task	2016-03-10 23:53:43 -08:00
LICENSE	chore: update license to MIT	2016-01-08 14:10:38 -08:00
README.md	chore(README): fix url	2016-03-09 11:20:51 +01:00
firebase.json	routing(dart): add a rule to redirect folks to dart docs	2016-03-11 14:30:46 -08:00
gulpfile.js	chore: add gulp link-checker task	2016-03-10 23:53:43 -08:00
harp.json	chore(bios): remove inactive team members	2016-03-16 21:23:52 -07:00
package.json	chore: add gulp link-checker task	2016-03-10 23:53:43 -08:00

README.md

Angular.io

Angular.io is site for Angular 2 documentation .

This site also includes links to other helpful angular resources including Angular 2, Angular 1, Angular Material, and AngularFire.

Issues

Please file Developer Guide, Cookbook, and code sample issues only in this Angular.io github repo.

Angular API issues, cheatsheet corrections, feature requests, defect reports, and technical questions concerning Angular itself belong in the angular source code github repo. We can't handle those topics here and will ask you to re-post them on the angular repo.

How you can help

Filing issues is helpful but pull requests that improve the docs are even better!

Learn how to contribute to Angular.io.

Development Setup

This site relies heavily on node and npm.

Make sure you are using the latest node and npm; if not install nvm to get node going on your machine.
install these npm packages globally: npm install -g harp gulp protractor
clone this repo and the angular source code repo to the same parent directory. The two cloned repo directories must be sibling.
cd into root directory Angular.io/
install local packages by running npm install

Content Development

All documentation content is written in Jade which has its own syntax. Be aware of the strict demands imposed by this significant-whitespace language. We strongly recommend running one of the gulp serve-and-sync commands described below while editing content so you can see the effect of your changes as you type.

The documentation relies on specific styles and mixins. Learn about those in the documentation styleguide.

The jade documentation files are language-specific directories under either public/docs/. For example, all of the TypeScript docs are in public/docs/ts/latest, e.g.

public/docs/ts/latest/quickstart.jade
public/docs/ts/latest/guide/architecture.jade
public/docs/ts/latest/cookbook/component-communication.jade
public/docs/ts/latest/tutorial/toh-pt5.jade

Local server with watches and browser reload

cd into root directory Angular.io/
run gulp serve-and-sync
browser will launch on localhost:3000 and stay refreshed automatically.

If you are only going to work on a specific part of the docs, such as the dev guide, then you can use one of the more specific gulp tasks to only watch those parts of the file system:

gulp serve-and-sync : watch all the local Jade/Sass files, the API source and examples, and the dev guide files
gulp serve-and-sync-api-docs : watch only the API source and example files
gulp serve-and-sync-devguide : watch only the dev guide files
gulp build-and-serve : watch only the local Jade/Sass files

Code Sample Development

All documentation is supported by sample code and plunkers. Such code resides in the public/docs/_examples directory, under chapter-specific directories, further divided by language track.

For example, the TypeScript QuickStart sample is in public/docs/_examples/quickstart/ts.

All samples are in a consistent directory structure using the same styles and the same npm packages, including the latest release of Angular 2. This consistency is possible in part thanks to gulp-driven tooling. To run the samples locally and confirm that they work properly, take the following extra steps to prepare the environment:

cd to public/docs/_examples
install the canonical node packages for all samples by running npm install
cd back up to Angular.io root.
run gulp add-example-boilerplate (elevate to admin on windows) to copy canonical files to the sample directories and create symlinks there for node_modules and typings.

Now cd into any particular sample's language directory (e.g., public/docs/_examples/quickstart/ts) and try:

npm start to simultaneously compile-with-watch and serve-in-browser-with-watch
npm run tsc to compile only
npm run lite to serve-and-watch in browser

Look at the scripts in package.json for other options. Also, open any plunkr.no-link.html to see the code execute in plunker (you may have to run gulp build-plunkers first to create/update).

Sample end-to-end tests

All samples should be covered to some degree by end-to-end tests.

Run them yourself: gulp run-e2e-tests.

Technology Used

Angular 1.x: The production ready version of Angular
Angular Material: An implementation of Material Design in Angular.js
Gulp: node-based tooling
Harp: The static web server with built-in preprocessing.
Sass: A professional grade CSS extension language
Normalize: A modern, HTML5-ready alternative to CSS resets
Grids: A highly customizable CSS Grid Framework built with Sass
Prettify: A JS module and CSS for syntax highlighting of source code snippets.
Icomoon: Custom built icon fonts