Quick Start Guide

Get up and running with mdsync.app in 5 minutes.

Step 1: Sign Up

1. Visit mdsync.app
2. Click "Get Started" on the landing page
3. Sign in with your Google account (this is your primary authentication)

Step 2: Connect GitHub

1. In the dashboard, click "Connect GitHub"
2. You'll be redirected to GitHub to authorize mdsync.app
3. Grant access to repositories and webhooks (required for syncing)
4. You'll be redirected back to the dashboard

Step 3: Connect Notion

1. In the dashboard, click "Connect Notion"
2. You'll be redirected to Notion to authorize mdsync.app
3. Select the workspace you want to use
4. Grant permission to create and update pages
5. You'll be redirected back to the dashboard

Step 4: Create Your First Sync

1. Click "Add Synchronization" button in the dashboard
2. Step 1 - Repository: Select a GitHub repository from the dropdown
3. Step 2 - Folder: Choose a folder path (use "/" for root, or "/docs" for a specific folder)
4. Step 3 - Branch: Select which Git branch to sync from (default: "main")
5. Step 4 - Notion Page: Select a Notion page as the destination (or create a new one)
6. Step 5 - Webhook (if on Starter/Pro): Enable automatic webhooks for auto-sync
7. Step 6 - Confirm: Review your settings and click "Create Synchronization"

Step 5: Test It

1. Make a change to a markdown file in your GitHub repository
2. Commit and push the changes
3. If webhooks are enabled, the sync will trigger automatically
4. If on the Free plan, click "Sync" manually in the dashboard
5. Check Notion - your changes should appear!

Need Help?

• Check out our detailed Guides
• Review the Creating Your First Sync guide
• Contact support at info@rosyai.lt