Go to file
Peter Bacon Darwin 1616cae5cf build(aio): add renderExamples processor
This processor will eventually replace the `{@example}` inline tags
because it provides a cleaner approach that also supports tabbed examples
straight out of the box.

The idea is that authors will simply add a `path` and (optionally) a `region`
attribute to `<code-example>` or `<code-pane>` elements in their docs.
This indicates to dgeni that the relevant example needs to be injected
into the content of this element.

For example, assume that there is an example file `toh-pt1/index.hml` with
a region called `title`, which looks like:

```
<h1>Tour of Heroes</h1>
```

Then the document author could get this to appear in the docs as a
standalone example:

```
<code-example path="toh-pt1" region="title"></code-example>
```

Or as part of a tabbed group:

```
<code-tabs>
  <code-pane path="toh-pt1" region="title"></code-pane>
</code-tabs>
```

If no `path` attribute is provided then the element is ignored, which
enables authors to provide inline code instead:

```
<code-example>
 Some &lt;html&gt escaped code
</code-example>
```

Also all attributes other than `path` and `region` are ignored and passed
through to the final rendered output allowing the author to provide
styling hints:

```
<code-example path="toh-pt1" region="title" linenums"15" class="important">
</code-example>
```
2017-03-25 21:32:30 +00:00
.github docs(gh): try to improve the issue template (#11891) 2016-09-30 16:40:56 -07:00
aio build(aio): add renderExamples processor 2017-03-25 21:32:30 +00: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 feat(router): introduce `ParamMap` to access parameters 2017-03-20 09:19:32 -07:00
packages fix(compiler): allow single quotes into named interpolations (#15461) 2017-03-24 15:10:41 -07:00
scripts docs: move markdown docs from root dir to docs/ and remove obsolete files (#15410) 2017-03-22 22:50:12 -07:00
tools release: cut the 4.0.0 release 2017-03-23 16:45:16 -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(forms): add tina as secondary for forms (#15262) 2017-03-20 17:13:52 -05:00
.travis.yml ci(travis): update excluded branch to g3 (#15391) 2017-03-22 17:15:38 -07:00
CHANGELOG.md docs: add the 4.0.0 code name to the changelog 2017-03-23 17:46:02 -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.0.0 release 2017-03-23 16:45:16 -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.