Entwicklerhandbuch¶
Willkommen im ConfluenceSynkMD-Entwicklerhandbuch. Dieser Bereich ist für Mitwirkende und Entwickler, die die Codebasis verstehen, erweitern oder Fehler beheben möchten.
Technologie-Stack¶
| Komponente | Technologie |
|---|---|
| Runtime | .NET 10 |
| CLI-Framework | System.CommandLine |
| Markdown Parser | Markdig |
| HTML Parser | AngleSharp (für XHTML → Markdown) |
| DI Container | Microsoft.Extensions.DependencyInjection |
| Logging | Serilog |
| Testing | xUnit + Moq |
| Diagramme | mermaid-cli (Node.js) |
| Container | Docker (Multi-Stage-Build) |
Repository-Struktur¶
ConfluenceSynkMD/
├── src/ConfluenceSynkMD/ # Hauptanwendung
│ ├── Configuration/ # Einstellungs-Records
│ ├── ETL/ # Extract-Transform-Load-Pipeline
│ ├── Markdig/ # Benutzerdefinierte Markdig-Renderer
│ ├── Models/ # Domänenmodelle
│ └── Services/ # API-Client, Resolver, Renderer
├── tests/ConfluenceSynkMD.Tests/ # Unit- & Integrationstests
├── docs/ # MkDocs-Dokumentation (diese Seite)
└── Dockerfile # Multi-Stage Docker-Build
Einstieg¶
git clone https://github.com/OpenDocSync/ConfluenceSynkMD.git
cd ConfluenceSynkMD
dotnet restore
dotnet build
dotnet test
Weiterführend¶
- Architektur — ETL-Muster, Layer-Verantwortlichkeiten und Datenfluss
- ETL-Pipeline — Pipeline-Builder, Step-Interfaces und Batch-Kontext
- Markdig-Renderer — Benutzerdefinierte Renderer und Erweiterung
- Bauen & Testen — Build, Test, Coverage und Round-Trip-Tests
- Mitwirken — Code-Stil, Commit-Konventionen und PR-Prozess