Monorepo setup
Configure the documentation path and content directory in a monorepo project so Mintlify deploys only from your designated docs folder.
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:
your-repo/
├── apps/
│ ├── web/
│ └── api/
├── docs/
│ ├── docs.json
│ └── quickstart.mdx
└── package.jsonIn this example, you'd set your documentation path to /docs.
Prerequisites
Section titled “Prerequisites”- Admin access to your Mintlify project.
- Documentation files organized in a dedicated directory within your monorepo.
- A valid
docs.jsonin your documentation directory.
Configure monorepo deployment
Section titled “Configure monorepo deployment”Access Git settings
Navigate to Git Settings in your dashboard.
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.
Set your documentation path
- Enable the docs.json is in a subdirectory toggle.
- Enter the relative path to your docs directory. For example, if your docs are in the
docsdirectory, enter/docs.
- Click Save changes. Saving triggers a new deployment from the configured path.