Skip to content

User Guide

Welcome to the ConfluenceSynkMD User Guide. This section covers everything you need to synchronize Markdown documentation with Confluence.

Sync Modes

ConfluenceSynkMD supports three synchronization modes:

Mode Direction Description
Upload Markdown → Confluence Convert and upload Markdown files as Confluence pages
Download Confluence → Markdown Fetch Confluence pages and convert them to Markdown
LocalExport Markdown → Local XHTML Convert Markdown to Confluence Storage Format locally (no API calls)

When to Use Each Mode

Upload

Use Upload when you want to publish your Markdown documentation to Confluence. This is the primary workflow: write in Markdown, push to Confluence.

dotnet run --project src/ConfluenceSynkMD -- \
  --mode Upload --path ./docs --conf-space DEV

dotnet run --project src/ConfluenceSynkMD -- `
  --mode Upload --path ./docs --conf-space DEV

dotnet run --project src/ConfluenceSynkMD -- ^
  --mode Upload --path .\docs --conf-space DEV

Download

Use Download when you want to pull existing Confluence pages into your local repository as Markdown files. Useful for:

  • Initial migration from Confluence → Markdown
  • Syncing back changes made directly in Confluence
dotnet run --project src/ConfluenceSynkMD -- \
  --mode Download --path ./output --conf-space DEV --conf-parent-id 12345

dotnet run --project src/ConfluenceSynkMD -- `
  --mode Download --path ./output --conf-space DEV --conf-parent-id 12345

dotnet run --project src/ConfluenceSynkMD -- ^
  --mode Download --path .\output --conf-space DEV --conf-parent-id 12345

LocalExport

Use LocalExport when you want to preview the Confluence Storage Format (XHTML) output without making any API calls. Useful for debugging or CI pipelines.

dotnet run --project src/ConfluenceSynkMD -- \
  --mode Upload --path ./docs --conf-space DEV --local

dotnet run --project src/ConfluenceSynkMD -- `
  --mode Upload --path ./docs --conf-space DEV --local

dotnet run --project src/ConfluenceSynkMD -- ^
  --mode Upload --path .\docs --conf-space DEV --local

Key Features