iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-docs-cn/aio
History
Peter Bacon Darwin 3f8d5ac478 feat(aio): support annotating JSON files with doc-regions 
This change allows the example writer to add doc-region annotations to
files that do not allow comments. This is done by creating a clone of the
file and adding `.annotated` to the file name. This new file can contain
inline `// ...` comments that can be used to annotate the doc regions.

Example:

**package.json**

```
{
  "name": "angular.io",
  "version": "0.0.0",
  "main": "index.js",
  "repository": "git@github.com:angular/angular.git",
  "author": "Angular",
  "license": "MIT",
  "private": true,
}
````

**package.json.annotated**

```
{
  "name": "angular.io",
// #docregion version
  "version": "0.0.0",
// #enddocregion
  "main": "index.js",
  "repository": "git@github.com:angular/angular.git",
  "author": "Angular",
  "license": "MIT",
  "private": true,
}
````

This region can then be referenced in examples just like any other doc region:

```
{@example 'package.json' region="version"}
```
 		2017-02-23 23:23:58 -08:00
..
build build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
content feat(compiler): introduce `<ng-template>`, deprecate `<template>` and `template` attribute 2017-02-23 20:03:16 -08:00
e2e test(aio): redefine pipe test as a pending test to confirm code example 2017-02-22 17:53:56 -08:00
src build(aio): upgrade to CLI beta.32 and MD beta.2 2017-02-22 17:53:56 -08:00
transforms feat(aio): support annotating JSON files with doc-regions 2017-02-23 23:23:58 -08:00
.angular-cli.json build(aio): upgrade to CLI beta.32 and MD beta.2 2017-02-22 17:53:56 -08:00
.firebaserc build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
README.md build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
database.rules.json build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
firebase.json fix(aio): use cleanUrls option rather than bruteforce rewriting rule (#14547) 2017-02-16 15:26:59 -08:00
gulpfile.js build: check yarn version in `check-environment` (#14499) 2017-02-22 20:55:25 -08:00
karma.conf.js build(aio): upgrade to CLI beta.32 and MD beta.2 2017-02-22 17:53:56 -08:00
package.json build: check yarn version in `check-environment` (#14499) 2017-02-22 20:55:25 -08:00
protractor.conf.js build(aio): upgrade to CLI beta.32 and MD beta.2 2017-02-22 17:53:56 -08:00
tslint.json build(aio): upgrade to CLI beta.32 and MD beta.2 2017-02-22 17:53:56 -08:00
yarn.lock build(aio): upgrade to CLI beta.32 and MD beta.2 2017-02-22 17:53:56 -08:00

README.md

Site

This project was generated with angular-cli version 1.0.0-beta.26.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class/module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

Deploying to GitHub Pages

Run ng github-pages:deploy to deploy to GitHub Pages.

Further help

To get more help on the angular-cli use ng help or go check out the Angular-CLI README.