mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
693dbc361f
* Fix Vale style warnings across docs from past week of merges Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
52 lines
1.8 KiB
Plaintext
52 lines
1.8 KiB
Plaintext
---
|
|
title: "Files"
|
|
description: "Serve static assets like images, videos, PDFs, and data files from your documentation repository with automatic optimization and CDN delivery."
|
|
keywords: ["static assets","supported file types"]
|
|
boost: 3
|
|
---
|
|
|
|
Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`.
|
|
|
|
You can make any supported file type available to your users, including OpenAPI specifications, images, videos, and more.
|
|
|
|
Files must be less than 20 MB.
|
|
|
|
<Note>
|
|
File serving is not supported for documentation sites with authentication enabled. If your site requires authentication, static files are not accessible at their direct URLs.
|
|
</Note>
|
|
|
|
## Supported file types
|
|
|
|
Supported file types for all plans:
|
|
|
|
- **Images**: `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.svg`, `.ico`
|
|
- **Video**: `.mp4`, `.webm`
|
|
- **Audio**: `.mp3`, `.wav`
|
|
- **Data**: `.json`, `.yaml`
|
|
- **Stylesheet**: `.css`
|
|
- **Scripts**: `.js`
|
|
- **Fonts**: `.woff`, `.woff2`, `.ttf`, `.eot`
|
|
|
|
Supported file types for Enterprise plans:
|
|
|
|
- **Documents**: `.pdf`, `.txt`
|
|
- **Data**: `.xml`, `.csv`
|
|
- **Archives**: `.zip`
|
|
|
|
## File organization
|
|
|
|
Organize your files using folders to keep your repository easy to navigate:
|
|
|
|
```text
|
|
/your-project
|
|
|- docs.json
|
|
|- images/
|
|
|- logo.png
|
|
|- screenshots/
|
|
|- dashboard.png
|
|
|- assets/
|
|
|- whitepaper.pdf
|
|
|- demo-video.mp4
|
|
```
|
|
|
|
Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. From the previous example, `assets/whitepaper.pdf` would be available at `https://docs.your-project.com/assets/whitepaper.pdf`. |