Skip to main content
Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have /images/logo.png in your repo, the image file is available at https://docs.your-project.com/images/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. To serve larger files, store them with Git LFS.
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.

​
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:
Mintlify serves files 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.

​
Large files with Git LFS

Git LFS support requires an Enterprise plan. Contact your account manager to enable it.
If your repository stores files with Git Large File Storage (LFS), Mintlify downloads each file from GitHub when you deploy and serves it at its path like any other static file. Files stored with Git LFS can be larger than 20 MB, but they must still be a supported file type. To store a file with Git LFS, track it and push it to the branch Mintlify deploys from.
Mintlify only downloads a file again when it changes, so unchanged files don’t use your GitHub LFS bandwidth on later deployments. If Mintlify can’t download a file, for example because your GitHub LFS bandwidth quota is used up, the deployment still succeeds. The previous version of the file stays live, and the deployment log shows a warning with the file path and the reason. Git LFS support works with repositories on GitHub.com. It isn’t supported for GitHub Enterprise Server, GitLab, or Bitbucket repositories, or for sites with authentication enabled. Without Git LFS support, Mintlify serves the small LFS pointer file at the file’s path instead of the file itself, and the deployment log shows a warning.