You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/monorepo.mdx
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,39 @@
2
2
title: "Monorepo setup"
3
3
description: "Deploy your docs from a repo that contains multiple projects"
4
4
icon: "folder-git"
5
-
---
5
+
---
6
+
7
+
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.
8
+
9
+
## Prerequisites
10
+
11
+
* Admin or owner access to your Mintlify project.
12
+
* Documentation files organized in a dedicated directory within your monorepo.
13
+
* A valid `docs.json` in your documentation directory.
14
+
15
+
## Configure monorepo deployment
16
+
17
+
<Steps>
18
+
<Steptitle="Access Git settings">
19
+
Navigate to to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
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."
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."
31
+
/>
32
+
</Frame>
33
+
34
+
</Step>
35
+
<Steptitle="Set your documentation path">
36
+
1. Select the **Set up as monorepo** toggle button.
37
+
2. Enter the relative path to your docs directory.
0 commit comments