History

dario-piotrowicz ef15b979cf docs(core): edit and add docs for ng-template (#42704 ) PR Close #42704		2021-07-12 09:39:29 -07:00
..
core	docs(core): edit and add docs for ng-template (#42704 )	2021-07-12 09:39:29 -07:00
README.md	feat(docs-infra): add support for "special elements" (#41299 )	2021-06-16 14:01:16 -07:00

README.md

Special Elements

Each sub-directory below this contains documentation that describes "special elements". These are elements that can appear in templates that have special meaning and behaviour in the Angular framework.

Each element should have a markdown file with the same file name as the element's tag name, e.g. ng-container.md. The file should be stored in a directory whose name is that of the Angular package under which this element should appear in the docs (usually core).

Short description

The file should contain a "short description" of the element. This is the first paragraph in the file.

Long description

All the paragraphs after the short description are collected as an additional longer description.

Element attributes

If the special element accepts one or more attributes that have special meaning to Angular, then these should be documented using the @elementAttribute tag. These tags should come after the description.

The format of this tag is:

@elementAttribute attr="value"

Description of the attribute and value.