mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
Deliver web apps with confidence 🚀
3f8d5ac478
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"}
```
|
||
|---|---|---|
| .github | ||
| aio | ||
| docs | ||
| integration | ||
| modules | ||
| scripts | ||
| tools | ||
| .bowerrc | ||
| .clang-format | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .pullapprove.yml | ||
| .travis.yml | ||
| bower.json | ||
| browser-providers.conf.js | ||
| build.sh | ||
| CHANGELOG.md | ||
| circle.yml | ||
| COMMITTER.md | ||
| CONTRIBUTING.md | ||
| DEVELOPER.md | ||
| gulpfile.js | ||
| karma-js.conf.js | ||
| LICENSE | ||
| NAMING.md | ||
| npm-shrinkwrap.clean.json | ||
| npm-shrinkwrap.json | ||
| npm-shrinkwrap.readme.md | ||
| package.json | ||
| protractor-e2e.conf.js | ||
| protractor-examples-e2e.conf.js | ||
| protractor-perf.conf.js | ||
| publish-packages.sh | ||
| README.md | ||
| SAVED_REPLIES.md | ||
| shims_for_IE.js | ||
| test-main.js | ||
| test.sh | ||
| TOOLS.md | ||
| TRIAGE_AND_LABELS.md | ||
| tslint.json | ||
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
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.