From 51384de8257761e114a027297fe31c243b96c47f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 24 Sep 2025 11:49:14 -0700 Subject: [PATCH 1/3] move static assets info to new page --- components/files.mdx | 31 +++++++++++++++++++++++++++++++ image-embeds.mdx | 2 -- 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 components/files.mdx diff --git a/components/files.mdx b/components/files.mdx new file mode 100644 index 000000000..4b0453e6f --- /dev/null +++ b/components/files.mdx @@ -0,0 +1,31 @@ +--- +title: "Files" +description: "Manage static assets in your documentation" +icon: "folder" +--- + +Mintlify automatically serves static assets from your documentation repository, making it easy to include images, documents, and other files in your docs. + +## Static asset serving + +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`. + +This works for any file type - images, PDFs, videos, or other documents you want to make available to your users. + +## File organization + +Organize your files using folders to keep your repository clean: + +``` +/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. \ No newline at end of file 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`. - Date: Wed, 24 Sep 2025 11:50:49 -0700 Subject: [PATCH 2/3] add new page to nav --- docs.json | 1 + 1 file changed, 1 insertion(+) 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", From 8369d5790b9766f3ef37401cc178c2b452fd2caa Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 24 Sep 2025 12:54:49 -0700 Subject: [PATCH 3/3] edit and add file size limits --- components/files.mdx | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/components/files.mdx b/components/files.mdx index 4b0453e6f..e3956e0a2 100644 --- a/components/files.mdx +++ b/components/files.mdx @@ -1,22 +1,20 @@ --- title: "Files" -description: "Manage static assets in your documentation" +description: "Serve static assets from your documentation" icon: "folder" --- -Mintlify automatically serves static assets from your documentation repository, making it easy to include images, documents, and other files in your docs. +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`. -## Static asset serving +This works for any file type you want to make available to your users, including images, PDFs, videos, or schemas. -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`. - -This works for any file type - images, PDFs, videos, or other documents you want to make available to your users. +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 clean: +Organize your files using folders to keep your repository easy to navigate: -``` +```text /your-project |- docs.json |- images/ @@ -28,4 +26,4 @@ Organize your files using folders to keep your repository clean: |- demo-video.mp4 ``` -Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. \ No newline at end of file +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`.