> ## Documentation Index
> Fetch the complete documentation index at: https://newwebsite.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Sync

> Connect your project to GitHub for version control and collaboration

# GitHub Sync

GitHub Sync allows you to connect your new\.website project to a GitHub repository. This feature enables you to:

1. **Export your project** to a new GitHub repository
2. **Sync changes** between new\.website and GitHub
3. **Collaborate** with others using GitHub's tools
4. **Version control** your website content

## Setting up GitHub Sync

### Step 1: Access the Sync Feature

In the editor, locate and click the **Sync** button in the top navigation bar.

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-1.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=9fba08f4365d065d92474bd0b6cce233" alt="Click the Sync button in the editor" width="2610" height="1346" data-path="images/features/github/step-1.png" />

### Step 2: Connect to GitHub

Click the **Connect GitHub** button to begin the integration process.

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-2.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=beaa8892a1e0a27782aa8c10ecd3c223" alt="Click Connect GitHub button" width="3016" height="1308" data-path="images/features/github/step-2.png" />

### Step 3: Install new\.website Sync App

You'll be redirected to GitHub where you need to install the new\.website Sync app. Select your GitHub profile or organization where you want to install the app.

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-3.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=39d2d6e28e5d56487619351363d02959" alt="Select GitHub profile or organization" width="1286" height="476" data-path="images/features/github/step-3.png" />

### Step 4: Configure Repository Access

Choose "All repositories" when prompted to configure the repository access level for the new\.website Sync app.

<Warning>
  **Important:** new\.website only works if you grant access to **All repositories**. Selecting "Only select repositories" will prevent the sync feature from functioning properly.
</Warning>

The app requires:

* Read access to metadata
* Read and write access to administration and code

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-4.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=74325a86ed370b636cbfc50a343e5e38" alt="Configure repository permissions" width="2332" height="1434" data-path="images/features/github/step-4.png" />

Click **Install & Authorize** to continue.

### Step 5: Create New Repository

After authorization, return to the new\.website editor and click the **Sync** button again. You'll now see the option to "Connect the project to a new repository."

Enter your desired repository name in the text field and click **Create**.

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-5.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=50fda1f090a79a07c34633a8504525f8" alt="Enter repository name and click Create" width="1276" height="600" data-path="images/features/github/step-5.png" />

### Step 6: Confirmation

You'll see a success notification confirming that your project has been connected and exported to GitHub.

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-6.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=c3e8dd6d1bc4b12cdd454e57e90c1a80" alt="Success notification" width="753" height="227" data-path="images/features/github/step-6.png" />

### Step 7: View on GitHub

Your new repository is now available on GitHub with all your project files synced.

<img src="https://mintcdn.com/newwebsite/Z_VRK3RlJdmz2aWE/images/features/github/step-7.png?fit=max&auto=format&n=Z_VRK3RlJdmz2aWE&q=85&s=74f6ae1e6f201ce9ff1ae8b77bcd6060" alt="Repository created on GitHub" width="1658" height="244" data-path="images/features/github/step-7.png" />

## How Sync Works

Once connected, any changes you make in new\.website will automatically sync to your GitHub repository. Similarly, changes made directly in GitHub will be reflected in your new\.website project, allowing you to work seamlessly between both platforms.

This bidirectional sync enables you to:

* Edit content using new\.website's visual editor
* Make code changes directly in GitHub
* Collaborate with team members using GitHub's pull request workflow
* Maintain a complete version history of your project

## Next Steps

With GitHub sync enabled, you can now:

* Invite collaborators to your GitHub repository
* Set up automated deployments from GitHub
* Use GitHub's issue tracking and project management tools
* Create branches for feature development
