Eklentiler Olmadan Markdown'ı Confluence Storage Formatına Dönüştürme Rehberi
Mühendislik ekipleri, yazılım mimarları, ürün yöneticileri ve teknik yazarlar; teknik dokümantasyon, mimari karar kayıtları (ADR), sistem tasarımları ve depo README dosyalarını hazırlamak için büyük ölçüde Markdown'a güvenir. Markdown hafiftir, insan tarafından okunabilir, Git aracılığıyla sürüm kontrollüdür ve geliştirici ortamları arasında taşınabilirdir. Ancak kurumsal ekipler, merkezi kurumsal bilgi tabanı ve dahili wiki olarak sıklıkla Atlassian Confluence'ı kullanır. Git tabanlı Markdown dosyaları ile Confluence sayfaları arasındaki boşluğu doldurmak, mühendislik departmanları için tarihsel olarak sıkıntılı ve parçalanmış bir süreç olmuştur.
Markdown'ı Confluence'a Dönüştürmek Neden Zorluğudur?
Confluence, web düzenleyicisine yapıştırılan ham Markdown metnini yerel olarak işlemez. Modern Confluence Cloud, Atlassian Document Format (ADF) ve temel Confluence Storage Format (XHTML tabanlı bir XML şeması) kullanırken, daha eski Confluence Server ve Data Center örnekleri Confluence Wiki Markup'a dayanır. Geliştiriciler standart Markdown'ı doğrudan Confluence'ın görsel sayfa düzenleyicisine yapıştırdıklarında, yaygın biçimlendirme öğeleri can sıkıcı şekillerde bozulur:
- Kod Blokları Sözdizimi Vurgulamasını Kaybeder: Düz üçlü ters tırnak kod blokları (
```python), biçimlendirilmemiş düz metin paragraflarına veya genel önceden biçimlendirilmiş kutulara dönüşerek sözdizimi renklendirmesini ve dil tanımlarını kaldırır. - Tablolar Dağılır: Dikey çizgi ayırıcıları (
|) içeren Markdown tabloları, yapılandırılmış Confluence HTML tabloları olarak işlenemez; görsel düzenleyicide üst bilgilerin, satırların ve sütunların manuel olarak yeniden oluşturulmasını gerektirir. - Vurgu ve Uyarı Panelleri Bozulur: Özel alıntılar (
> [!NOTE]veya> [!WARNING]), Confluence'ın renk kodlu Bilgi, Uyarı, Not veya Başarı makro kapsayıcıları olmadan temel alıntılara dönüşür. - Görev Onay Kutuları ve Listeler Senkronizasyonunu Kaybeder: Etkileşimli görev öğeleri (
- [x] Task), Confluence'ın yerel etkileşimli onay kutuları yerine düz metin madde işaretlerine dönüşür. - Başlık Hiyerarşisi ve Bağlantılar Bozulur: Başlık yapıları (
# H1,## H2) standart içindekiler tablosu eşlemesini kaybederek uzun teknik makalelerdeki derin bağlantıları bozar.
Üçüncü Taraf Sunucu Tabanlı Dönüştürücülerin Güvenlik Riski
Birçok popüler çevrimiçi Markdown dönüştürme aracı, uzak sunucu uç noktalarına HTTP POST istekleri göndererek kullanıcı metnini işler. Geliştiriciler dahili yazılım dokümantasyonunu, altyapı diyagramlarını, API anahtarlarını, veritabanı şemalarını veya özel algoritmaları bulut barındırmalı dönüştürücüler kullanarak dönüştürdüklerinde, yanlışlıkla hassas kurumsal verileri üçüncü taraf altyapılarına iletme riskiyle karşı karşıya kalırlar.
Kurumsal güvenlik politikaları, SOC 2 uyumluluk standartları, ISO 27001 kuralları ve HIPAA düzenlemeleri, dahili kod belgelerinin denetlenmemiş web hizmetlerine yüklenmesini kesinlikle yasaklar. Utiliome, tüm Markdown ayrıştırma ve XHTML/XML çeviri motorunu yerel olarak web tarayıcınız içinde çalıştırarak bu temel güvenlik açığını çözer. Modern JavaScript Web API standartlarını, Web Worker'ları ve istemci tarafı AST (Abstract Syntax Tree) dönüştürme mantığını kullanan Markdown metniniz asla tarayıcı DOM'unuzdan ayrılmaz. Hiçbir API çağrısı gönderilmez, uzak veritabanları sorgularınızı kaydetmez ve hiçbir kurumsal fikri mülkiyet dış sunuculara maruz kalmaz.
Confluence Storage Format ve Confluence Wiki Markup: Çıktıyı Anlamak
Geliştirici dokümantasyonunu Confluence'a aktarırken, sorunsuz bir yapıştırma işlemi için uygun çıktı formatını seçmek çok önemlidir:
1. Confluence Storage Format (XHTML XML)
Confluence Storage Format, Confluence Cloud ve modern REST API'leri tarafından kullanılan temel depolama temsilidir. <ac:structured-macro>, <ac:parameter> ve <ac:rich-text-body> gibi özel XML ad alanlarını kullanır. Utiliome, standart Markdown öğelerini tam Confluence XML düğümlerine eşler:
- Kod Blokları: Tam dili tanımlayan parametre etiketleriyle
<ac:structured-macro ac:name="code">olarak çevrilir (ör.python,typescript,bash,json,yaml). - Uyarı Panelleri: Markdown uyarıları, özel başlıklara ve biçimlendirilmiş HTML gövdelerine sahip
<ac:structured-macro ac:name="info">,warning,noteveyatipbiçimine çevrilir. - Zengin Veri Tabloları: Markdown tabloları, stillendirilmiş
<th>üst bilgileri ve temiz<td>veri hücreleri içeren güçlü XHTML<table>yapılarına dönüştürülür.
2. Confluence Wiki Markup
Confluence Wiki Markup, eski Confluence Server, Confluence Data Center ve belirli içe aktarma makrolarında kullanılan klasik metin sözdizimidir. {code:python}...{code}, {note}...{note} ve h2. Heading Title gibi kısaltma notasyonlarını kullanır. Utiliome'un dönüştürücüsü, sıfır performans gecikmesiyle Storage Format XML ve Wiki Markup arasında anında geçiş yapmanızı sağlar.
Otomatik Dokümantasyon Senkronizasyonu İçin Adım Adım İş Akışı
Markdown'dan Confluence'a dönüştürmeyi günlük geliştirme iş akışınıza entegre etmek 30 saniyeden az sürer:
- Markdown kaynağınızı hazırlayın: Teknik şartnamenizi, sürüm notlarınızı veya sprint değerlendirmenizi VS Code, Obsidian, GitHub veya herhangi bir metin düzenleyicide taslak haline getirin.
- Utiliome'un Ücretsiz Dönüştürücüsünü Açın: Herhangi bir modern web tarayıcısında (Chrome, Firefox, Safari, Edge) dönüştürücü sayfasına gidin.
- Dosyanızı Yapıştırın veya Bırakın: Metninizi düzenleyiciye ekleyin. Canlı önizleme, siz yazarken veya yapıştırırken gerçek zamanlı olarak güncellenir.
- Çıktı Modunu Seçin: Confluence dağıtımınıza karşılık gelen çıktı sekmesine tıklayın (Confluence Cloud için Storage Format XML veya Server/Data Center için Wiki Markup).
- Confluence'a Yapıştırın: Hedef Confluence sayfanızı düzenleme modunda açın,
Insert > Markupseçeneğine tıklayın (veya kaynak düzenleyici eklentileri aracılığıyla doğrudan depolama formatını yapıştırın) ve kusursuz dokümantasyonunuzu yayınlayın.