Skip to content

Document migrating from Mintlify-hosted to own repository #2382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yangleyland wants to merge 2 commits into from
+37 −2
Closed

Document migrating from Mintlify-hosted to own repository #2382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fee7da
Update deploy/github.mdx
yangleyland Dec 17, 2025
75c6c20
Update quickstart.mdx
yangleyland Dec 17, 2025
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
37 changes: 36 additions & 1 deletion deploy/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,42 @@ Mintlify uses a GitHub App to automatically sync your documentation with your Gi
See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard.
</Tip>

If your repository is in the `mintlify-community` organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository.
If your repository is in the `mintlify-community` organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, you can [migrate to your own repository](#migrate-to-your-own-repository).

## Migrate to your own repository

If you started with a Mintlify-hosted repository and want to move your documentation to your own GitHub account, you can migrate at any time. This copies all your documentation files to a new repository under your GitHub account.

### Prerequisites

You need a GitHub account with permission to create repositories.

### Migration steps

<Steps>
<Step title="Go to Git Settings">
Navigate to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
</Step>
<Step title="Start the migration">
Click **Create new repo from current docs**.
</Step>
<Step title="Authorize GitHub">
If prompted, complete the GitHub OAuth flow to grant Mintlify permission to create a repository in your account.
</Step>
<Step title="Wait for completion">
Mintlify copies your documentation files to a new repository in your GitHub account. The repository is named `docs`, `mintlify-docs`, or a similar available name.
</Step>
</Steps>

### What happens during migration

When you migrate:

- A new repository is created in your GitHub account with all your current documentation files.
- Your deployment is updated to point to the new repository.
- The Mintlify-hosted repository is no longer used for deployments.

After migration, you can clone the new repository locally, make changes in your preferred editor, and push updates to trigger deployments.

## Install the GitHub App

Expand Down
2 changes: 1 addition & 1 deletion quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Choose your repository approach.
</CardGroup>

<Tip>
Not sure which to choose? Start with **Mintlify-hosted**. You can migrate to your own repository anytime if it better suits your needs.
Not sure which to choose? Start with **Mintlify-hosted**. You can [migrate to your own repository](/deploy/github#migrate-to-your-own-repository) anytime if it better suits your needs.
</Tip>

## Deploy your documentation site
Expand Down