Passer au contenu principal
Mintlify diffuse automatiquement les ressources statiques depuis votre référentiel de documentation à l’emplacement approprié sur votre domain. Par exemple, si vous avez /images/my-logo.png dans votre référentiel, le fichier image est disponible à l’URL https://docs.your-project.com/images/my-logo.png. Vous pouvez rendre disponibles pour vos utilisateurs tous les types de fichiers pris en charge, y compris des spécifications OpenAPI, des images, des vidéos, et plus encore. Les fichiers doivent faire moins de 20 Mo pour les images et 100 Mo pour les autres types de fichiers.
La diffusion de fichiers n’est pas prise en charge pour les sites de documentation avec l’authentification activée. Si votre site nécessite une authentification, les fichiers statiques ne seront pas accessibles via leurs URL directes.

Types de fichiers pris en charge

Types de fichiers pris en charge pour toutes les formules :
  • Images : .png, .jpg, .jpeg, .gif, .webp, .svg, .ico
  • Vidéo : .mp4, .webm
  • Audio : .mp3, .wav
  • Données : .json, .yaml
  • Feuilles de style : .css
  • Scripts : .js
  • Polices : .woff, .woff2, .ttf, .eot
Types de fichiers pris en charge pour les formules Custom :
  • Documents : .pdf, .txt
  • Données : .xml, .csv
  • Archives : .zip

Organisation des fichiers

Organisez vos fichiers à l’aide de dossiers pour que votre référentiel reste facile à naviguer :
/votre-projet
  |- docs.json
  |- images/
    |- logo.png
    |- screenshots/
      |- dashboard.png
  |- assets/
    |- whitepaper.pdf
    |- demo-video.mp4
Les fichiers sont servis depuis la racine de votre domain, de sorte que la structure de votre référentiel corresponde directement à la structure des URL. Dans l’exemple précédent, assets/whitepaper.pdf serait accessible à l’adresse https://docs.your-project.com/assets/whitepaper.pdf.