Zum Inhalt

Benutzerhandbuch

Willkommen im ConfluenceSynkMD-Benutzerhandbuch. Dieser Bereich deckt alles ab, was Sie zur Synchronisation von Markdown-Dokumentation mit Confluence benötigen.

Synchronisationsmodi

Modus Richtung Beschreibung
Upload Markdown → Confluence Markdown-Dateien konvertieren und als Confluence-Seiten hochladen
Download Confluence → Markdown Confluence-Seiten abrufen und in Markdown konvertieren
LocalExport Markdown → Lokales XHTML Markdown lokal in Confluence Storage Format konvertieren (keine API-Aufrufe)

Wann welchen Modus verwenden?

Upload

Verwenden Sie Upload, wenn Sie Ihre Markdown-Dokumentation auf Confluence publizieren möchten.

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

Verwenden Sie Download, um bestehende Confluence-Seiten in Ihr lokales Repository als Markdown-Dateien zu ziehen.

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

Verwenden Sie LocalExport für eine Vorschau des Confluence Storage Formats ohne API-Aufrufe.

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

Funktionen