Skip to content

ConfluenceSynkMD

Bidirectional Markdown ↔ Confluence synchronization for teams.

ConfluenceSynkMD is a .NET 10 CLI tool that syncs Markdown documentation with Atlassian Confluence Cloud. Write in Markdown, publish to Confluence, download changes back β€” fully automated and round-trip safe.


✨ Highlights

  • Bidirectional Sync β€” Upload Markdown β†’ Confluence, Download Confluence β†’ Markdown, or Local Export
  • Hierarchical Pages β€” Preserves your directory structure as a parent–child page tree
  • Diagram Rendering β€” Mermaid, Draw.io, PlantUML, and LaTeX β†’ image attachments
  • Image Optimization β€” Automatic downscaling and compression before upload
  • GitHub Alerts β€” [!NOTE], [!WARNING], [!TIP] β†’ Confluence macros
  • Frontmatter Support β€” YAML frontmatter for titles, labels, space key overrides
  • Round-Trip Fidelity β€” Page-ID write-back and source-path metadata for exact reconstruction

πŸ“– Choose Your Path

  • Quick Start


    Get up and running in under 5 minutes.

    Quick Start

  • User Guide


    Learn how to upload, download, and manage your docs.

    User Guide

  • Developer Guide


    Understand the architecture and contribute to the project.

    Developer Guide

  • Admin Guide


    Deploy, configure, and maintain ConfluenceSynkMD.

    Admin Guide

  • Reference


    Complete CLI flags, environment variables, and schemas.

    Reference


License

ConfluenceSynkMD is licensed under the MIT License.