File Download Block
Provide downloadable files to your readers. Upload documents, spreadsheets, code samples, or any file type. Files are stored with your content and published alongside your documentation.
The File Download block allows you to attach downloadable files to your documentation. Upload any supported file type, add a descriptive label and optional description, and readers can download the file directly from the published page.
When to Use
Documents
PDFs, Word documents, presentations, and spreadsheets
Code Samples
Source files, configuration templates, and scripts
Data Files
CSV exports, JSON data, and XML configurations
Archives
ZIP files containing multiple resources
Templates
Starter projects, document templates, and boilerplate
Media
High-resolution images, audio files, and video clips
Uploading Files
Block Fields
Supported File Types
The following file types are supported for upload:
How It Works
Best Practices
| Practice | Description |
|---|---|
| Use descriptive labels | Tell readers exactly what they are downloading. "Q4 2025 Sales Report" is better than "report.xlsx". |
| Include version info | If files are updated over time, include version numbers in the label or description. |
| Keep files small | Compress images and consider breaking large archives into smaller chunks for faster downloads. |
| Provide context | Use the description field to explain what the file contains and how to use it. |
| Use standard formats | Prefer widely-supported formats like PDF over proprietary ones where possible. |
Viewer Presentation
In the published site, file download blocks appear as a compact card showing: