Download Button

A download button provides a way to link files for users to download directly from the documentation. This can be useful for sharing resources such as PDFs, software packages, templates, or any other downloadable content. Instead of manually adding links, the button is structured as an object to maintain consistency and ease of customization.

Example

Each download button is stored as an object inside the contents array of a page. The object must have a type property, a label that defines the button text, and a target that specifies the file path or URL.

Different variations of the download button can be used to indicate the nature of the provided file. The type property supports multiple values for styling and context. Using download creates a standard button, while download-info, download-success, download-warning, and download-danger apply different visual styles to convey additional meaning. These variations help users distinguish between general downloads, informational resources, successful actions, warnings, or potentially critical files.

Download Example Download Example Download Example Download Example Download Example