Tutorials#

Step-by-step guides for common Export Pro tasks.


Tutorial 1: Exporting a Single Page to Markdown#

Learn how to export a single Confluence page to Markdown format.

Steps#

  1. Navigate to any Confluence page
  2. Open the page actions menu (three dots icon)
  3. Select Export Pro
  4. Step 1 - Select Scope: Choose “Current Page Only”
  5. Step 2 - Select Formats: Ensure “Markdown” is selected (default)
  6. Step 3 - Options:
    • Enable “Include Frontmatter” if you want YAML metadata
    • Leave “Export as Single File” unchecked (not applicable for single page)
  7. Click Start Export
  8. The file downloads directly as <page-title>.md

Result#

A single Markdown file containing your page content, optionally with YAML frontmatter.


Tutorial 2: Exporting a Page Hierarchy#

Export a parent page along with all its child and descendant pages.

Steps#

  1. Navigate to a parent page with child pages
  2. Open the page actions menu and select Export Pro
  3. Step 1 - Select Scope: Choose “Include Child Pages”
  4. Step 2 - Select Formats: Select your desired format(s)
  5. Step 3 - Options:
    • Enable “Export as Single File” to combine all pages into one document
    • Or leave disabled to get a ZIP with individual files preserving folder structure
  6. Click Start Export
  7. Watch the discovery phase find all child pages
  8. Monitor the export progress in real-time
  9. Download completes automatically

Result#

A ZIP archive containing all pages in the hierarchy, organized in folders matching the Confluence page tree structure.


Tutorial 3: Exporting an Entire Space#

Export all pages from a Confluence space.

Steps#

  1. Navigate to any page within the target space
  2. Open the page actions menu and select Export Pro
  3. Step 1 - Select Scope: Choose “Entire Space”
  4. Step 2 - Select Formats: Select your desired format(s)
  5. Step 3 - Options: Configure as needed
  6. Click Start Export
  7. The app will paginate through all space pages (250 per batch)
  8. Monitor progress in the metrics chart
  9. Download the ZIP archive when complete

Result#

A ZIP archive containing all pages from the space as individual files.


Tutorial 4: Including Metadata in Exports#

Add YAML frontmatter with page metadata to your Markdown exports.

Steps#

  1. Open Export Pro on any page
  2. Select your desired scope
  3. Step 2: Ensure “Markdown” format is selected
  4. Step 3: Enable Include Frontmatter
  5. Click Start Export

Result#

Each Markdown file will include frontmatter like:

---
title: "Page Title"
created: 2024-01-15
updated: 2024-01-20
author: "user123"
labels: ["documentation", "api"]
path: "folder/page-title.md"
---

Use Case#

This is essential for static site generators like Hugo, Jekyll, or Docusaurus that use frontmatter for page metadata.


Tutorial 5: Combining Multiple Pages into One File#

Create a single document containing all exported pages.

Steps#

  1. Open Export Pro and select either:
    • “Include Child Pages”, or
    • “Entire Space”
  2. Step 2: Select your desired format(s)
  3. Step 3: Enable Export as Single File
  4. Click Start Export

Result#

Instead of a ZIP with multiple files, you’ll get:

  • A single file for single-format exports
  • A ZIP with one combined file per format for multi-format exports

All pages are concatenated with page titles as section headers.


Tutorial 6: Exporting Multiple Formats Simultaneously#

Export to multiple formats in a single operation.

Steps#

  1. Open Export Pro on any page
  2. Step 1: Select your desired scope
  3. Step 2: Select multiple format checkboxes (e.g., Markdown + HTML)
  4. Step 3: Configure options
  5. Click Start Export

Result#

  • Single page: ZIP containing one file per format
  • Multi-page: ZIP with folders or files organized by format

Tutorial 7: Debugging Export Issues#

Use debug mode to troubleshoot export problems.

Steps#

  1. Open Export Pro
  2. Configure your export as usual
  3. Step 3: Enable Debug Mode
  4. Click Start Export
  5. Switch to the Log tab (appears after starting)
  6. View detailed logs in real-time

What to Look For#

  • API errors: Check for failed requests
  • Page issues: Identify pages causing problems
  • Conversion errors: See which content couldn’t be converted
  • Timing info: Understand where time is spent

Reporting Issues#

When reporting bugs, include the debug log output to help us diagnose the problem quickly.


Tutorial 8: Handling Large Space Exports#

Best practices for exporting large Confluence spaces.

Preparation#

  1. Use Chrome or Edge browser for File System Access API support
  2. Ensure stable internet connection
  3. Allow sufficient time for large exports

Steps#

  1. Navigate to a page in the target space
  2. Open Export Pro and select “Entire Space”
  3. Enable Debug Mode to monitor progress
  4. Click Start Export
  5. Watch the discovery phase (may take time for large spaces)
  6. Monitor the metrics chart for throughput:
    • Bar chart shows requests/second
    • Area chart shows KB/second
  7. Wait for completion or close the dialog to cancel

Tips#

  • The metrics chart shows the last 60 seconds of activity
  • Page counter updates in real-time during discovery
  • You can abort at any time by closing the modal
  • Large exports use streaming to avoid memory issues

Troubleshooting#

Export Doesn’t Start#

  1. Check browser compatibility (Chrome, Edge, Firefox, Safari)
  2. Verify you have permission to view the pages
  3. Refresh the page and try again

Download Fails#

  1. Check browser download settings
  2. Ensure sufficient disk space
  3. Try a smaller export first

Missing Content#

  1. Verify the pages exist and are accessible
  2. Check if content uses unsupported macros
  3. Enable Debug Mode to see conversion details

Slow Export#

  1. Large spaces naturally take longer
  2. Check network connection
  3. Monitor the metrics chart for throughput
  4. Consider exporting smaller sections