Skip to content

Local Export

Local Export converts Markdown to Confluence Storage Format (XHTML) on your local filesystem without making any API calls. This is useful for previewing, debugging, or CI validation.


Usage

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

Note

The --local flag overrides the mode to LocalExport regardless of the --mode value. The --conf-space is still required for link resolution but no API calls are made.


Output

The exported XHTML files are written alongside your Markdown sources. Each .md file produces a corresponding .html file containing the Confluence Storage Format output.


Use Cases

Preview Before Upload

Run a local export to inspect the generated XHTML before pushing to Confluence:

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

CI Pipeline Validation

Add a local export step to your CI pipeline to verify that all Markdown files convert successfully:

- name: Validate Confluence conversion
  run: |
    dotnet run --project src/ConfluenceSynkMD -- \
      --mode Upload --path ./docs --conf-space DEV --local

Debugging Conversion Issues

Combine with --debug-line-markers and --loglevel debug for detailed output:

dotnet run --project src/ConfluenceSynkMD -- \
  --mode Upload --path ./docs --conf-space DEV \
  --local --debug-line-markers --loglevel debug
dotnet run --project src/ConfluenceSynkMD -- `
  --mode Upload --path ./docs --conf-space DEV `
  --local --debug-line-markers --loglevel debug
dotnet run --project src/ConfluenceSynkMD -- ^
  --mode Upload --path .\docs --conf-space DEV ^
  --local --debug-line-markers --loglevel debug