mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Leyland Yang
31c847dce4
* Update deploy/vercel.mdx Co-Authored-By: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com> * Update deploy/docs-subpath.mdx Co-Authored-By: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com> --------- Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
63 lines
3.2 KiB
Plaintext
63 lines
3.2 KiB
Plaintext
---
|
|
title: "Vercel"
|
|
description: "Deploy documentation to a subpath on Vercel."
|
|
keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"]
|
|
---
|
|
|
|
import { VercelJsonGenerator } from "/snippets/vercel-json-generator.mdx";
|
|
|
|
Configure your `vercel.json` file to proxy requests from your main domain to your documentation at a subpath.
|
|
|
|
## vercel.json file
|
|
|
|
The `vercel.json` file configures how your project builds and deploys. It sits in your project's root directory and controls various aspects of your deployment, including routing, redirects, headers, and build settings.
|
|
|
|
We use the `rewrites` configuration in your `vercel.json` file to proxy requests from your main domain to your documentation.
|
|
|
|
Rewrites map incoming requests to different destinations without changing the URL in the browser. When someone visits `yoursite.com/docs`, Vercel internally fetches content from `your-subdomain.mintlify.dev/docs`, but the user still sees `yoursite.com/docs` in their browser. This is different from redirects, which send users to another URL entirely.
|
|
|
|
## Configuration
|
|
|
|
### Host at `/docs` subpath
|
|
|
|
1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard.
|
|
2. Click the **Host at `/docs`** toggle to the on position.
|
|
<Frame>
|
|
<img alt="Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle." src="/images/subpath/toggle-light.png" className="block dark:hidden" />
|
|
<img alt="Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle." src="/images/subpath/toggle-dark.png" className="hidden dark:block" />
|
|
</Frame>
|
|
3. Enter your domain.
|
|
4. Select **Add domain**.
|
|
5. Add the following rewrites to your `vercel.json` file. Replace `[subdomain]` with your subdomain, which is found at the end of your dashboard URL. For example, `dashboard.mintlify.com/your-organization/your-subdomain` has a domain identifier of `your-subdomain`.
|
|
|
|
```json
|
|
{
|
|
"rewrites": [
|
|
{
|
|
"source": "/docs",
|
|
"destination": "https://[subdomain].mintlify.dev/docs"
|
|
},
|
|
{
|
|
"source": "/docs/:match*",
|
|
"destination": "https://[subdomain].mintlify.dev/docs/:match*"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The `rewrites` configuration maps the `/docs` subpath on your domain to the `/docs` subpath on your documentation.
|
|
|
|
- **`source`**: The path pattern on your domain that triggers the rewrite.
|
|
- **`destination`**: Where the request should be proxied to.
|
|
- **`:match*`**: A wildcard that captures any path segments after your subpath.
|
|
|
|
For more information, see [Configuring projects with vercel.json: Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites) in the Vercel documentation.
|
|
|
|
### Host at custom subpath
|
|
|
|
To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if your documentation is hosted at `yoursite.com/help`, your documentation files must be in a `help/` directory.
|
|
|
|
Use the generator below to create your rewrites configuration. Add the rewrites to your `vercel.json` file.
|
|
|
|
<VercelJsonGenerator />
|