Authoring landing page descriptions for Experience League

You can achieve consistent presentation for guide descriptions (and links) and on your landing pages. To accomplish this, use the following description metadata fields and keep them to about 20 words in length. This practice consistently displays three lines for descriptions on Experience League.

  • user-guide-description: For user guides, open TOC.md and edit the description of your guide. This text describes the entire guide.
  • landing-page-description: For articles, opn the article.md, edit landing-page-description, which applies to the page.

You can see this presentation below:

landing page

Descriptions get complicated because we use three different descriptions in three different locations, and each have different guidelines.

More resources:

On this page