跳转到主要内容
Mintlify 会在你的 domain 上的相应路径,自动从你的文档存储库提供静态资源。比如,如果你的存储库中有 /images/my-logo.png,该图像文件可通过 https://docs.your-project.com/images/my-logo.png 访问。 这适用于你希望向用户提供的任何文件类型,包括图像、PDF、视频或模式文件。 对于图像,文件必须小于 20 MB;其他文件类型必须小于 100 MB。

支持的文件扩展名

Mintlify 支持以下静态文件扩展名。

图像格式

  • .jpeg, .jpg, .jfif, .pjpeg, .pjp
  • .png
  • .svg, .svgz
  • .ico
  • .webp
  • .gif, .apng
  • .avif
  • .bmp
  • .tiff, .tif

视频格式

  • .mp4
  • .webm
  • .ogg
  • .avi
  • .mov
  • .wmv
  • .flv
  • .mkv
  • .m4v

音频格式

  • .mp3
  • .wav
  • .flac
  • .aac
  • .ogg
  • .wma
  • .m4a

文档格式

  • .pdf
  • .txt
  • .doc.docx
  • .xls.xlsx
  • .ppt.pptx
  • .rtf
  • .odt.ods.odp

数据格式

  • .csv
  • .tsv
  • .xml

文件结构

使用文件夹来组织文件,使你的存储库更易于浏览:
/your-project
  |- docs.json
  |- images/
    |- logo.png
    |- screenshots/
      |- dashboard.png
  |- assets/
    |- whitepaper.pdf
    |- demo-video.mp4
文件从你的 domain 根目录提供,因此存储库中的结构会直接映射到 URL 结构。依据前面的示例,assets/whitepaper.pdf 可通过 https://docs.your-project.com/assets/whitepaper.pdf 访问。
I