mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Mintlify Agent
44 lines
1.8 KiB
Plaintext
44 lines
1.8 KiB
Plaintext
---
|
|
title: "Monorepo setup"
|
|
description: "Configure documentation path and content directory for monorepo projects."
|
|
keywords: ["monorepo", "content directory", "multi-project repository"]
|
|
---
|
|
|
|
Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in <span style={{ backgroundImage: 'linear-gradient(90deg, #ff0000, #ff7f00, #ffff00, #00ff00, #0000ff, #4b0082, #9400d3)', backgroundClip: 'text', WebkitBackgroundClip: 'text', WebkitTextFillColor: 'transparent' }}>repositories</span> that contain multiple projects or services.
|
|
|
|
## 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://dashboard.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. Select the **Set up as monorepo** toggle button.
|
|
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. Select **Save changes**.
|
|
</Step>
|
|
</Steps>
|