mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
ade1fbbd39
* docs: address reader-question gaps in recently updated pages * docs: shorten analytics description, split long sentence, mirror translations --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
63 lines
2.2 KiB
Plaintext
63 lines
2.2 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.
|
|
|
|
<Note>
|
|
A monorepo deployment uses a single repository with a subdirectory of docs. To combine content from more than one repository into one site, see [Multi-repository deployments](/deploy/multi-repo).
|
|
</Note>
|
|
|
|
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, showing the docs.json is in a subdirectory toggle enabled and a path to the /docs directory 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, showing the docs.json is in a subdirectory toggle enabled and a path to the /docs directory specified."
|
|
/>
|
|
</Frame>
|
|
|
|
</Step>
|
|
<Step title="Set your documentation path">
|
|
1. Enable the **docs.json is in a subdirectory** 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**. Saving triggers a new deployment from the configured path.
|
|
</Step>
|
|
</Steps>
|