Developer Guide¶

Welcome to the ConfluenceSynkMD Developer Guide. This section is for contributors and developers who want to understand the codebase, extend functionality, or fix bugs.

Tech Stack¶

Component	Technology
Runtime	.NET 10
CLI Framework	`System.CommandLine`
Markdown Parser	Markdig
HTML Parser	AngleSharp (for XHTML → Markdown)
DI Container	`Microsoft.Extensions.DependencyInjection`
Logging	Serilog
Testing	xUnit + Moq
Diagrams	mermaid-cli (Node.js)
Container	Docker (multi-stage build)

Repository Structure¶

ConfluenceSynkMD/
├── src/ConfluenceSynkMD/           # Main application
│   ├── Configuration/             # Settings records
│   ├── ETL/                       # Extract-Transform-Load pipeline
│   │   ├── Core/                  # Pipeline runner, step interfaces
│   │   ├── Extract/               # Markdown & Confluence ingestion
│   │   ├── Transform/             # MD→XHTML and XHTML→MD conversion
│   │   └── Load/                  # Upload, download, local export
│   ├── Markdig/                   # Custom Markdig renderers
│   ├── Models/                    # Domain models
│   └── Services/                  # API client, resolvers, renderers
├── tests/ConfluenceSynkMD.Tests/   # Unit & integration tests
├── docs/                          # MkDocs documentation (this site)
└── Dockerfile                     # Multi-stage Docker build

Getting Started¶

# Clone and build
git clone https://github.com/OpenDocSync/ConfluenceSynkMD.git
cd ConfluenceSynkMD
dotnet restore
dotnet build

# Run tests
dotnet test

Dive Deeper¶

Architecture — ETL pattern, layer responsibilities, and data flow
ETL Pipeline — Pipeline builder, step interfaces, and batch context
Markdig Renderers — Custom renderers and how to add new ones
Building & Testing — Build, test, coverage, and round-trip testing
Contributing — Code style, commit conventions, and PR process