42289f25c6
The purpose of the changes is to clean all markdown to match a single pedantic style.
* To ensure all changes in style are properly separated.
* To ensure all styled content aligns to nearest 4-character-tab.
* To ensure all code blocks use the Angular `<code-example>` or `<code-tab>` elements.
* To ensure all markdown exists outside of html tags.
* To ensure all images use the Angular style for `<img>` elements.
* To ensure that all smart punctuation is replaced or removed.
```text
’, ’, “, ”, –, —, …
```
* To ensure all content does not conflict with the following reserved characters.
```text
@, $, *, &, #, |, <, >,
```
* To ensure all content displays using html entities.
The following changes were made to files in the following directory.
```text
aio/content
```
The target files were markdown files.
The list of excluded files:
```text
.browserslistrc, .css, .conf, .editorconfig, .gitignore, .html, .js, .json, .sh, .svg, .ts, .txt, .xlf,
```
PR Close #45325
|
||
|---|---|---|
| .. | ||
| core | ||
| 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 for example, `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.
@reviewed 2022-02-28