Landing pages and breadcrumbs

The landing pages are generated based on the markdown files in the landing-pages.en repo. There is a home landing page for EXL document, a home tutorial page, and product landing pages for each major Experience Cloud or Experience Platform product.

Note the following:

  • Landing pages markdown syntax rules are different from other AdobeDocs repos.
  • Validation rules for landing pages are different from other AdobeDocs repos.
  • The term “landing page” is sometimes confused with “home page,” which is the first article in a guide’s TOC.
  • The landing pages support only images and links in a set format. No images, tables, or videos are supported.

Section headings

The syntax after a heading (such as :::guides-list and :::tutorial-list) help determine which CSS design element is used for that section.

  • For each guides section, add :::guides-list at the start of the list and ::: at the bottom of the list.
  • For each tutorials section, add :::tutorial-list at the start of the list and ::: at the bottom of the list.
  • If a section needs to have sub-sections, add a simple parent section (such as ## Guides) and add subsections (such as ## Administration) with the appropriate ::: syntax.

Note that there is also a tier value based on the filename: home.md and home-tutorials are in one tier, a filename with -tutorials is another tier, and all other files are in another tier. Tiers are part of the design consideration that is handled with backend code, not with markdown syntax.

For links, use the following syntax as an example:

:::guides-list

-   [Experience Platform Overview](/en/docs/experience-platform/landing/home)
    Learn how Experience Platform makes it possible to deliver personalized experiences to your customers in real time with guides, documentation, and tutorials.
-   [AI Assistant](/en/docs/experience-platform/ai-assistant/home)
    Learn how to use AI Assistant to expedite your workflow with Adobe Experience Platform and Real-Time Customer Data Platform.
:::

Add the article link with the title and URL. The URL should omit the https://experienceleague.adobe.com domain. On a separate line, add the description for sections in which descriptions are displayed (Guides and Tutorials). We no longer extract descriptions from repos as we did in V1.

In v1, breadcrumb links at the top of the page were determined by breadcrumb-name and child-repos syntax in landing pages. In v2, these are ignored. Instead, the breadcrumbs are determined in each repo by the landing-page-name and landing-page-breadcrumb-title in each repo’s metadata.md or TOC.md file.

landing-page-name landing-page-name

Where used: metadata.md or TOC.md

Example: landing-page-name: experience-manager

Requirements: Use landing-page-name to link to the landing page to be used in the breadcrumb. Also specify landing-page-breadcrumb-title to indicate the name of the breadcrumb that appears.

landing-page-breadcrumb-title landing-page-breadcrumb-title

Where used: metadata.md or TOC.md

Example: landing-page-breadcrumb-title: AEM

Requirements: Specify landing-page-breadcrumb-title to indicate the name of the breadcrumb that appears. Also use landing-page-name to link to the landing page to be used in the breadcrumb.

Adding text to landing pages

The template design allows description text only after the H1 title. Any content added to H2 sections and below will be ignored.

recommendation-more-help
authoring-guide-help-main-guide