Download

View as Markdown

The <Download> component lets users download assets like PDFs directly from your documentation.

For information on how to embed images, PDFs, and other assets, check out the documentation on Rich media in Markdown.

Usage

Markdown
1<Download src="./all-about-ferns.pdf">
2 <Button intent="primary">Download PDF</Button>
3</Download>

Properties

src
stringRequired

Path to your local asset (relative to current MDX file). The asset must be located within the fern folder.

children
React.ReactNodeRequired

The text or element to display as the click target for the download.

filename
string

The filename to use for the downloaded asset. If not provided, the filename will be the same as the asset’s name.