Files
mintlify__docs/deploy/monorepo.mdx
mintlify[bot] 21f454e8d6 docs: fix minor style inconsistencies across English docs (#5996)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-26 15:51:25 -07:00

59 lines
1.9 KiB
Plaintext

---
title: "Monorepo setup"
description: "Configure the documentation path and content directory in a monorepo project so Mintlify deploys only from your designated docs folder."
keywords: ["monorepo", "content directory", "multi-project repository"]
---
Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup lets you maintain documentation alongside your code in repositories that contain multiple projects or services.
A typical monorepo structure might look like this:
```text
your-repo/
├── apps/
│ ├── web/
│ └── api/
├── docs/
│ ├── docs.json
│ └── quickstart.mdx
└── package.json
```
In this example, you'd set your documentation path to `/docs`.
## Prerequisites
* Admin access to your Mintlify project.
* Documentation files organized in a dedicated directory within your monorepo.
* A valid `docs.json` in your documentation directory.
## Configure monorepo deployment
<Steps>
<Step title="Access Git settings">
Navigate to [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) in your dashboard.
<Frame>
<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/monorepo-light.png"
alt="The project settings panel in the Git Settings menu. The Set up as monorepo toggle button is enabled and a path to the /docs directory is specified."
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/monorepo-dark.png"
alt="The project settings panel in the Git Settings menu. The Set up as monorepo toggle button is enabled and a path to the /docs directory is specified."
/>
</Frame>
</Step>
<Step title="Set your documentation path">
1. Click the **Set up as monorepo** toggle.
2. Enter the relative path to your docs directory. For example, if your docs are in the `docs` directory, enter `/docs`.
<Note>
Do not include a trailing slash in the path.
</Note>
3. Click **Save changes**.
</Step>
</Steps>