Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion advanced/subpath/cloudflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Host documentation at a /docs subpath using Cloudflare Workers"

import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";

<SubpathGatingSnippet />
<SubpathGatingSnippet platform="Cloudflare" />

## Create Cloudflare Worker

Expand Down
2 changes: 1 addition & 1 deletion advanced/subpath/route53-cloudfront.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Host documentation at a /docs subdirectory using AWS services"

import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";

<SubpathGatingSnippet />
<SubpathGatingSnippet platform="AWS Services" />

## Create Cloudfront Distribution

Expand Down
40 changes: 40 additions & 0 deletions advanced/subpath/vercel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Vercel"
description: "Host documentation at a /docs subpath using Vercel"
---

import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";

<SubpathGatingSnippet platform="Vercel" />

## Mint.json Configuration

To host your documentation at a custom subpath using Vercel, you need to add the
following configuration to your `vercel.json` file.

```json
{
"rewrites": [
{
"source": "/docs",
"destination": "https://[subdomain].mintlify.dev/docs"
},
{
"source": "/docs/:match*",
"destination": "https://[subdomain].mintlify.dev/docs/:match*"
}
]
}
```

<Note>
For more information, you can also refer to Vercel's offical guide on check
out the [Project Configuration:
Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites)
</Note>

## Reach out to Mintlify team

Once completing the Vercel setup, the Mintlify team will setup the
subdirectory settings in your deployment. Reach out over
[email](mailto:[email protected]).
3 changes: 2 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@
"group": "Custom Subpaths",
"pages": [
"advanced/subpath/cloudflare",
"advanced/subpath/route53-cloudfront"
"advanced/subpath/route53-cloudfront",
"advanced/subpath/vercel"
]
},
{
Expand Down
6 changes: 2 additions & 4 deletions snippets/custom-subpath-gating.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
<Info>

**Prerequisite**: Your primary domain (company.com) is hosted on Cloudflare
and you are on the [Mintlify startup plan or
above](https://mintlify.com/pricing).
**Prerequisite**: Your primary domain (company.com) is hosted on {platform}
and you are on the [Mintlify Pro plan or above](https://mintlify.com/pricing).
</Info>