diff --git a/components/files.mdx b/components/files.mdx new file mode 100644 index 000000000..e3956e0a2 --- /dev/null +++ b/components/files.mdx @@ -0,0 +1,29 @@ +--- +title: "Files" +description: "Serve static assets from your documentation" +icon: "folder" +--- + +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`. + +This works for any file type you want to make available to your users, including images, PDFs, videos, or schemas. + +Files must be less than 20 MB for images and 100 MB for other file types. + +## 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`. diff --git a/docs.json b/docs.json index 7e738d5e6..b451ec3d7 100644 --- a/docs.json +++ b/docs.json @@ -66,6 +66,7 @@ "pages": [ "text", "image-embeds", + "components/files", "list-table", "code", "reusable-snippets", diff --git a/image-embeds.mdx b/image-embeds.mdx index 3725e0d14..86b78b2da 100644 --- a/image-embeds.mdx +++ b/image-embeds.mdx @@ -6,8 +6,6 @@ icon: "image" Add images, embed videos, and include interactive content with iframes to your documentation. -All static assets in your docs repository are automatically served at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image will be available at `https://docs.yoursite.com/images/my-logo.png`. -