Export Options#
Configure your exports with powerful customization options.
Overview#
Export Pro provides several options to customize your exports:
| Option | Description | Applies To |
|---|---|---|
| Include Frontmatter | Add YAML metadata to exports | Markdown format |
| Export as Single File | Combine pages into one document | Multi-page exports |
| Debug Mode | Show detailed export logs | All exports |
Include Frontmatter#
Adds YAML frontmatter metadata to the beginning of Markdown exports.
What’s Included#
---
title: "Page Title"
created: 2024-01-15
updated: 2024-01-20
author: "user123"
labels: ["documentation", "api"]
path: "folder/page-title.md"
---Fields#
| Field | Description |
|---|---|
title |
The page title |
created |
Page creation date |
updated |
Last modification date |
author |
Author’s Atlassian account ID |
labels |
Array of page labels |
path |
Export file path within the archive |
Use Cases#
- Static site generators that use frontmatter (Hugo, Jekyll, Docusaurus)
- Content management systems
- Documentation sites with metadata requirements
- Preserving page metadata in exports
Availability#
- Only applies to Markdown format exports
- Available for all export scopes
Export as Single File#
Combines multiple pages into a single document instead of creating separate files.
Behavior#
- All pages concatenated into one file
- Page titles become section headers
- Maintains reading order based on discovery
- For multiple formats, one combined file per format
Output Example#
# Parent Page
Content of parent page...
---
# Child Page 1
Content of child page 1...
---
# Child Page 2
Content of child page 2...Use Cases#
- Creating unified documentation documents
- Generating printable documentation
- Single-file knowledge bases
- Simplified distribution
Availability#
- Only for multi-page exports (Child Pages or Entire Space)
- Works with all export formats
- When disabled, creates a ZIP with individual files
Debug Mode#
Enables detailed logging during the export process.
How to Use#
- In Step 3, enable Debug Mode
- Start the export
- Switch to the Log tab (appears during export)
- View real-time logs
What’s Logged#
- API requests and responses
- Page discovery progress
- Export processing steps
- Content conversion details
- Error details with stack traces
Log Levels#
| Level | Color | Description |
|---|---|---|
| INFO | Blue | General progress information |
| DEBUG | Gray | Detailed processing steps |
| WARN | Yellow | Non-critical warnings |
| ERROR | Red | Errors and failures |
Use Cases#
- Troubleshooting export issues
- Understanding export progress
- Identifying problematic pages
- Reporting bugs with detailed information
Export Phases#
Understanding the export process helps you use options effectively:
| Phase | Description |
|---|---|
idle |
Initial state, waiting for configuration |
discovering |
Finding all pages to export |
exporting |
Downloading and converting content |
complete |
Export finished successfully |
error |
Export failed with error |
Phase Indicators#
- Progress bar shows current phase
- Page counter updates during discovery
- Metrics chart shows throughput during export
- Status messages indicate current activity
Metrics and Progress#
Export Pro provides real-time metrics during export:
Metrics Chart#
- Bar chart: Requests per second
- Area chart: KB/s throughput
- Rolling window: Last 60 seconds displayed
Counters#
- Total pages discovered
- Pages exported
- Data transferred (KB)
- Export duration
Handling Large Exports#
For large exports, Export Pro uses streaming downloads:
File System Access API (Chrome/Edge)#
- Direct streaming to user-selected file location
- No memory limitations
- Best performance for large exports
Service Worker Fallback#
- For browsers without File System Access API
- Creates virtual download stream
- Automatic cleanup after download
Tips for Large Exports#
- Use Chrome or Edge for best performance
- Enable Debug Mode to monitor progress
- Watch the metrics chart for throughput
- Export can be cancelled at any time by closing the dialog
File Naming#
Export Pro sanitizes filenames for cross-platform compatibility:
Unsafe Characters Removed#
< > : " / \ | ? *
Naming Conventions#
- Page title used as filename
- Spaces and safe characters preserved
- Duplicate names get numeric suffixes:
page.md,page-2.md - Hierarchical exports preserve folder structure
Related Topics#
- Export Formats - Available output formats
- Export Scopes - Content selection options
- Tutorials - Step-by-step guides