Markdown++.

Offen wie Markdown – leistungsfähig genug für professionelle Produktdokumentation.

Markdown++ erweitert CommonMark um Funktionen, die technische Dokumentationen benötigen, beispielsweise Bedingungen, Variablen, strukturierte Querverweise, Includes und Formatierungsinformationen. Die Erweiterungen werden als für normale Markdown-Viewer unsichtbare Anweisungen gespeichert. Eine Markdown++-Datei bleibt dadurch gültiges Markdown. Die Spezifikation ist unter der MIT-Lizenz veröffentlicht.

Technische Dokumentation ohne proprietäre Abhängigkeit

Markdown++ verbindet einfach lesbare Textdateien mit den Funktionen professioneller Publishing-Prozesse – für Web, Print, Automatisierung und KI-fähige Wissensbestände.

Geschäftlicher Mehrwert

Ihre Inhalte bleiben zugänglich

Die Dateien sind lesbar, versionierbar und auch außerhalb eines einzelnen Redaktionswerkzeugs nutzbar.

Bessere Zusammenarbeit

Redaktion, Entwicklung und Produktexperten können mit vertrauten Git-, Review- und Freigabeprozessen arbeiten.

Geeignet für Automatisierung

Textbasierte Inhalte lassen sich gut in Build-, Release- und CI/CD-Prozesse integrieren.

Gute Grundlage für KI

Klare Strukturen und erhaltene semantische Informationen verbessern die Qualität der daraus erzeugten Knowledge Files. WebWorks beschreibt Markdown++ außerdem als Migrationsweg aus binären und proprietären Formaten.

Markdown++ im Vergleich zu DITA / DocBook.


Markdown++ bietet Funktionen für strukturierte Inhalte, die mit denen von DITA und DocBook vergleichbar sind, ohne dass Autoren XML schreiben oder pflegen müssen.


Holen Sie Ihr Team dort ab, wo es gerade steht.

Markdown++ ist darauf ausgelegt, Teams dort abzuholen, wo sie gerade stehen. Bestehende ePublisher-Kunden können Markdown++ einführen, ohne ihre Publishing-Pipeline ändern zu müssen.

Aus Microsoft Word

Profitieren Sie von Versionskontrolle mit aussagekräftigen Diff-Ansichten, ohne Bindung an ein binäres Format, sowie von Pull-Request-Prüfungen für Inhaltsänderungen. Benutzerdefinierte Formatierungen für Absätze und Zeichen werden über <!--style:-->-Anweisungen übernommen.

Aus Adobe FrameMaker

FrameMaker-.book-Dateien werden mithilfe von <!--include:-->-Anweisungen direkt in Markdown++-Buchzusammensetzungsdateien eingebunden. Bedingter Text, Variablen, Querverweise und Indexmarkierungen werden dabei vollständig übernommen.

Aus DITA-XML

DITA-Maps werden zu Dateistrukturen für Bücher. DITA-Themen werden zu .md-Dateien. Themenbasiertes Verfassen, Wiederverwendung von Inhalten, bedingte Verarbeitung, Metadaten und Ausgabe in verschiedenen Formaten bleiben erhalten – ohne den XML-Overhead.

Aus AsciiDoc, MDX, RST

AsciiDoc-Inhalte werden über die vorgelagerte Brücke „quadralay/asciidoctor-mdpp“ in die Pipeline eingebunden – einen Open-Source-Konverter, der gültiges Markdown++ erzeugt. Bei MDX und rST wird die nicht standardkonforme Syntax gegen vollständige CommonMark-Kompatibilität eingetauscht – jede Markdown++-Datei lässt sich in Standardtools sauber rendern, ohne JSX, ohne benutzerdefinierte Blocksyntax und ohne separaten Build-Schritt nur für die Vorschau.

Typische Zielgruppen

  • Softwareentwicklung und Developer Documentation
  • Docs-as-Code-Teams
  • Unternehmen mit Git-basierten Prozessen
  • Redaktionen, die Word oder FrameMaker schrittweise ablösen möchten
  • Organisationen, die Inhalte langfristig herstellerneutral halten wollen
  • Unternehmen, die Dokumentation für KI-Anwendungen strukturieren möchten

KI-fähige Dokumentation – durchgängig und zukunftssicher.

Vom Quellformat über die automatisierte Veröffentlichung bis zum Cloud-Service für Ihre KI-Assistenten – alle Komponenten sind perfekt aufeinander abgestimmt.


WebWorks

Donaustr. 36 | 90451 Nürnberg (Germany) | +49 911 215 3470 |  kontakt@squidds.de Impressum | Datenschutz