Contents

Links

A directive for authoring authoring embedded previews of documentation links (similar to how links are currently rendered in Topics sections) anywhere on the page without affecting page curation behavior.

Declaration

@Links(visualStyle: VisualStyle) {
    ...
}

Parameters

  • visualStyle:

    The specified style that should be used when rendering the specified links. (required)

    list

    A list of the linked pages, including their full declaration and abstract.

    compactGrid

    A grid of items based on the card image for the linked pages.

    Includes each page’s title and card image but excludes their abstracts.

    detailedGrid

    A grid of items based on the card image for the linked pages.

    Unlike compactGrid, this style includes the abstract for each page.

Overview

@Links gives authors flexibility in choosing how they want to highlight documentation on the page itself versus in the navigation sidebar. It also allows for mixing and matching different visual styles of topics.

...

### What's New in SlothCreator

@Links(visualStyle: compactGrid) {
   - <doc:get-started-preparing-sloth-food>
   - <doc:feeding-your-sloth-in-winter>
   - <doc:ordering-food-delivery>
}

...

See Also

Creating Custom Page Layouts