Go to file
Peter Bacon Darwin 58f080a325 build(aio): add `doc-watch` yarn task for docs authors
This task is suitable for day to day docs authoring.

This task cuts corners, which makes it much faster than a full `yarn docs`
run but it does not produce completely valid output.
In general this isgood enough for authors to see their changes as they make them.

The task is triggered by a call to

```
yarn docs-watch
```

This sets up watchers on the `aio/contents` and `packages` folders.
Any changes to files below these folders new doc generation run to start.
The input to the generation is confined to a collection of files related
to the changed file. For example:

* a change to a file in `aio/content/marketing` will generate all the
marketing files.
* a change to a file in `aio/content/tutorial` or `aio/examples/toh-*`
will generate all the tutorial files (and their embedded examples).
* a change to a file in `aio/guide` or `aio/examples` (but not a `toh-`
example) will generate the appropriate guide and its embedded examples
* a change to a file in `packages` or `packages/examples` will generate
the appropriate API doc and its embedded examples.

Be aware that the mapping between docs and its examples are based on doc file
and example folder structure being equivalent. Sometimes a doc will reference
an example in a different folder, in which case the generated doc will be
inaccurate. Mostly this is not a big problem.
2017-04-16 20:56:10 +01:00
.github docs(gh): try to improve the issue template (#11891) 2016-09-30 16:40:56 -07:00
aio build(aio): add `doc-watch` yarn task for docs authors 2017-04-16 20:56:10 +01:00
docs docs: revert the move of CONTRIBUTING.md to docs/CONTRIBUTING.md 2017-03-23 20:57:49 -07:00
integration fix: prevent strictNullChecks support until #15432 is fixed (#15434) 2017-03-23 14:54:19 -07:00
modules fix(core): Update types for TypeScript nullability support (#15472) 2017-03-29 09:34:45 -07:00
packages fix(forms): Update types for TypeScript nullability support 2017-04-14 15:10:26 -07:00
scripts ci(aio): verify that the Lighthouse PWA score remains above a threshold 2017-04-15 10:23:45 +01:00
tools fix(forms): Update types for TypeScript nullability support 2017-04-14 15:10:26 -07:00
.bowerrc chore(dgeni): clean up legacy typings bundle creation 2015-10-29 21:19:59 +00:00
.clang-format feat(tooling): Add a .clang-format for automated JavaScript formatting. 2015-04-02 08:44:34 -07:00
.editorconfig chore(.editorconfig): include markdown config 2015-01-27 00:14:48 -08:00
.gitattributes chore: force lf EOL for ts files (#11143) 2016-08-29 12:41:58 -07:00
.gitignore build(aio): use own `.gitignore` file 2017-03-17 15:31:22 -05:00
.nvmrc ci: bump node version to 6.9.5 and npm to 3.10.7 2017-02-02 23:28:00 -08:00
.pullapprove.yml ci: add jasonaden to the router 2017-04-11 11:16:02 -07:00
.travis.yml ci(travis): update excluded branch to g3 (#15391) 2017-03-22 17:15:38 -07:00
CHANGELOG.md docs: add changelog for 4.1.0-beta.1 2017-04-12 14:49:29 -07:00
CONTRIBUTING.md docs: fixed broken links (#15455) 2017-03-24 08:14:23 -07:00
LICENSE style(docs): update copyright years (#13736) 2017-01-27 20:47:14 -08:00
README.md docs: revert the move of CONTRIBUTING.md to docs/CONTRIBUTING.md 2017-03-23 20:57:49 -07:00
bower.json docs: branding fixes (#14132) 2017-01-27 15:03:11 -06:00
browser-providers.conf.js ci: disable Android 4.1, 4.2 and 4.3 in SauceLabs (#14461) 2017-03-16 09:13:07 -07:00
build.sh fix(forms): make composition event buffering configurable (#15256) 2017-03-21 16:47:18 -05:00
circle.yml build: update to yarn 0.21.3 (#14805) 2017-03-01 23:58:05 -08:00
gulpfile.js build: check yarn version in `check-environment` (#14499) 2017-02-22 20:55:25 -08:00
karma-js.conf.js fix: fix path locally to empty.js (#15073) 2017-03-15 13:40:24 -07:00
npm-shrinkwrap.clean.json fix(core): update peer dep on zone.js to ^0.8.5 (#15365) 2017-03-21 16:47:01 -05:00
npm-shrinkwrap.json fix(core): update peer dep on zone.js to ^0.8.5 (#15365) 2017-03-21 16:47:01 -05:00
npm-shrinkwrap.readme.md chore(lint): replace gulp check-task with tslint no-jasmine-focus rule 2016-10-28 15:53:15 -07:00
package.json release: cut the 4.1.0-beta.1 release 2017-04-12 14:39:22 -07:00
protractor-e2e.conf.js refactor: add license header to JS files & format files (#12081) 2016-10-04 20:39:20 -07:00
protractor-examples-e2e.conf.js refactor: format and lint code 2016-12-12 11:30:25 -08:00
protractor-perf.conf.js refactor: add license header to JS files & format files (#12081) 2016-10-04 20:39:20 -07:00
shims_for_IE.js Revert "refactor: add license header to JS files & format files (#12035)" 2016-10-04 14:06:41 -07:00
test-main.js fix: fix path locally to empty.js (#15073) 2017-03-15 13:40:24 -07:00
test.sh build: build modules and examples for karma 2017-03-08 17:35:20 -08:00
tslint.json build(tslint): enable no-inner-declarations (#13316) 2016-12-08 13:46:08 -08:00

README.md

Build Status CircleCI Join the chat at https://gitter.im/angular/angular Issue Stats Issue Stats npm version

Sauce Test Status Safari (7+), iOS (7+), Edge (14) and IE mobile (11) are tested on BrowserStack.

Angular

Angular is a development platform for building mobile and desktop web applications using Typescript/JavaScript (JS) and other languages.

Quickstart

Get started in 5 minutes.

Want to help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues in the hotlist: community-help.