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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@
"guides/migration",
"mcp",
"translations",
"guides/monorepo",
"react-components",
"settings/custom-scripts",
"settings/seo",
Expand Down
40 changes: 40 additions & 0 deletions guides/monorepo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Monorepo setup"
description: "Deploy your docs from a repo that contains multiple projects"
icon: "folder-git"
---

Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in repositories 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.
3. Select **Save changes**.
</Step>
</Steps>