angular/aio/tools/transforms/templates/api/includes/usageNotes.html

{%- if doc.usageNotes %}
<section class="usage-notes">
  <h2>Usage notes</h2>
  {$ doc.usageNotes | marked $}
</section>
{%- endif -%}
perf(docs-infra): reduce unnecessary whitespace in API docs (#43435) The HTML for the docs pages is generated by Dgeni based on some [Nunjucks][1] templates. Previously, these templates were set up in a way that introduced a lot excess whitespace in the generated HTML, unnecessarily bloating the corresponding JSON files that need to be downloaded in order to view a certain docs page. This has been discussed in #28105 and was again observed while investigating #43285. This commit refactors some of the templates related to API docs (which seem to be the most affected ones) to drastically reduce the amount of excess whitespace. More specifically, the total size of all files in `generated/docs/api/` was reduced from ~13MB to ~7MB. Besides the reduced payload size for each API page, this change will also reduce the amount of memory needed by the ServiceWorker to cache the API pages that have been visited by a user. NOTE: The affected files are not eagerly downloaded when navigating to angular.io. Instead, each file is downloaded individually, as soon as a user visits the corresponding API docs page. Therefore, the impact of this change will be relatively small for most users. [1]: https://mozilla.github.io/nunjucks/ PR Close #43435 2021-09-14 10:59:19 +00:00			`{%- if doc.usageNotes %}`
build(aio): split the description property in API docs (#22401) * The first paragraph is now split off into the `shortDescription` property. * Usage of `howToUse` and `whatItDoes` have been updated. * The "Overview" heading for class is removed as it is self-evident * The original horizontal rule styling below the main heading is removed as not part of the new design Closes #22385 PR Close #22401 2018-02-23 13:50:47 +00:00			`<section class="usage-notes">`
build(docs-infra): ensure all headings are sentence cased (#24527) PR Close #24527 2018-06-14 22:02:45 +00:00			`<h2>Usage notes</h2>`
build(aio): split the description property in API docs (#22401) * The first paragraph is now split off into the `shortDescription` property. * Usage of `howToUse` and `whatItDoes` have been updated. * The "Overview" heading for class is removed as it is self-evident * The original horizontal rule styling below the main heading is removed as not part of the new design Closes #22385 PR Close #22401 2018-02-23 13:50:47 +00:00			`{$ doc.usageNotes \| marked $}`
			`</section>`
perf(docs-infra): reduce unnecessary whitespace in API docs (#43435) The HTML for the docs pages is generated by Dgeni based on some [Nunjucks][1] templates. Previously, these templates were set up in a way that introduced a lot excess whitespace in the generated HTML, unnecessarily bloating the corresponding JSON files that need to be downloaded in order to view a certain docs page. This has been discussed in #28105 and was again observed while investigating #43285. This commit refactors some of the templates related to API docs (which seem to be the most affected ones) to drastically reduce the amount of excess whitespace. More specifically, the total size of all files in `generated/docs/api/` was reduced from ~13MB to ~7MB. Besides the reduced payload size for each API page, this change will also reduce the amount of memory needed by the ServiceWorker to cache the API pages that have been visited by a user. NOTE: The affected files are not eagerly downloaded when navigating to angular.io. Instead, each file is downloaded individually, as soon as a user visits the corresponding API docs page. Therefore, the impact of this change will be relatively small for most users. [1]: https://mozilla.github.io/nunjucks/ PR Close #43435 2021-09-14 10:59:19 +00:00			`{%- endif -%}`