[Marklas] Bidirektionaler Konverter für Markdown <-> Atlassian Document Format (ADF)
(github.com/byExist)Confluence und Jira speichern Dokumente als JSON-Struktur namens ADF (Atlassian Document Format). Wenn Seiten per API gelesen und geschrieben werden, muss dieses Format direkt verarbeitet werden, aber ADF-spezifische Funktionen wie Panels, Erwähnungen oder farbiger Text gehen bei der Umwandlung in Markdown verloren.
Marklas löst dieses Problem, indem ADF-spezifische Funktionen als HTML-Kommentar-Annotationen erhalten bleiben.
<!-- adf:panel {"panelType": "warning"} -->
Diese API wird in v2 entfernt.
<!-- /adf:panel -->
Die Annotationen werden in GitHub oder Editoren nicht gerendert und beeinträchtigen daher die Lesbarkeit nicht; beim erneuten Parsen wird die ursprüngliche ADF-Struktur unverändert wiederhergestellt.
ADF → Markdown (mit Annotationen) → ADF ✅ minimaler Verlust
Normales Markdown → ADF ✅ funktioniert
from marklas import to_adf, to_md
md = to_md(confluence_adf) # In Markdown umwandeln und bearbeiten
adf = to_adf(md) # Zurück in ADF umwandeln
Ich hatte zuvor kommerzielle Konvertierungsbibliotheken verwendet und sie als unpraktisch empfunden, deshalb habe ich das selbst entwickelt.
Python 3.13+, einzige externe Abhängigkeit ist mistune.
Noch keine Kommentare.