angular-cn/aio/tools/transforms/templates/api/includes/description.html

{% if doc.description %}
<section class="description">
  <h2>Description</h2>
  {$ doc.description | trimBlankLines | marked $}
  {% if doc.usageNotes %}<p>Further information is available in the <a href="#usage-notes">Usage Notes...</a></p>{%
  endif %}
</section>
{% endif %}
build(aio): refactor API templates for clean start 2017-05-02 15:08:49 +01:00			`{% if doc.description %}`
			`<section class="description">`
			`<h2>Description</h2>`
			`{$ doc.description \| trimBlankLines \| marked $}`
build(docs-infra): improve @usageNotes message (#42888) improve the @usageNotes message by adding the word "is" (outcome: "Further information is available in...", compared to "Further information available in...") PR Close #42888 2021-07-18 10:32:26 +01:00			`{% if doc.usageNotes %}<p>Further information is available in the <a href="#usage-notes">Usage Notes...</a></p>{%`
build(docs-infra): add a link to `usage notes` from `description` (#40835) The "Usage Notes" section is often at the bottom of a long page of content which can make it difficult to discover. This commit adds a link at the end of the "Description" if there is a "Usage Notes" section on the page. This link should help the reader to discover that there is more information available further down the page. This is basically a marginal fix. The longer term fix should be to consider what content goes in which sections and how they should be laid out on the page. See #40753 PR Close #40835 2021-02-13 13:56:33 +00:00			`endif %}`
build(aio): refactor API templates for clean start 2017-05-02 15:08:49 +01:00			`</section>`
			`{% endif %}`