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

1

Access Git settings

Navigate to Git Settings in your dashboard.
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.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.
2

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.
Do not include a trailing slash in the path.
  1. Select Save changes.