Help Documentation

Comprehensive guides and tutorials to help you get the most out of MarkFlow

Getting Started

Get Started with MarkFlow in Three Steps

1

Download and Install MarkFlow

Download the version suitable for your operating system from the official website and complete the installation

2

Configure Notion API Key

Enter your Notion API Key and target page URL in the settings page

3

Select Folder and Start Syncing

Select the folder containing Markdown files, preview and start syncing

Feature Guide

Manual Sync

Manually select files and sync to Notion. Precise control over sync content, graphical interface makes operation intuitive.

  • File Selection
  • Preview Function
  • Real-time Progress

Auto Sync

Intelligent file monitoring, customizable sync timing. File changes trigger automatic sync to Notion.

  • File Monitoring
  • Auto Trigger
  • Status Display

Configuration Management

Secure account connection, connection testing, page configuration. Set once, use forever.

  • API Key Configuration
  • Connection Testing
  • Secure Storage

History Records

Complete sync records, statistical analysis, search filtering. Make every operation traceable.

  • Sync Records
  • Statistical Analysis
  • Search Filtering

Configuration Guide

How to Get Notion API Key

  1. Visit Notion Developer Page Notion Developer Page
  2. Click "New integration" to create a new integration app
  3. Fill in the integration name (e.g., "MarkFlow") and select workspace
  4. Copy the generated "Internal Integration Token"
  5. Paste this Token in MarkFlow settings

Page Permission Settings

  1. Open the target page in Notion
  2. Click the "Share" button in the top right corner of the page
  3. Search for your created integration name in the "Invite" section
  4. Select the integration and click "Invite"
  5. Ensure the integration has "Edit" permissions

Troubleshooting

Sync failed, showing "API Key invalid"

Please check the following:

  • Confirm API Key is copied completely without extra spaces
  • Check if API Key has expired
  • Confirm integration app status is normal
Cannot access Notion page

Possible solutions:

  • Confirm page URL is correct
  • Check if integration has been invited to the page
  • Confirm integration has edit permissions
Auto Sync Not Working

Possible solutions:

  • Check if the folder path is correct
  • Confirm auto sync feature is enabled
  • Restart the application