Einführung

Mordoc ist ein Dokumentationswebsite-Generator, der auf Markdoc aufbaut und Ihre Inhalte in saubere, elegante und hochgradig benutzerfreundliche Dokumentationswebsites verwandelt.

Sie schreiben Markdown-Inhalte und einfache Konfigurationsdateien, und Mordoc kümmert sich um den Rest: Navigation, Layouts, Styling und Struktur. Das Ergebnis ist eine vollständig funktionsfähige Dokumentationswebsite, die von Anfang an professionell wirkt.

Warum Mordoc?

Es gibt viele großartige Dokumentationswerkzeuge, und viele von ihnen leisten bereits ausgezeichnete Arbeit. Also… warum noch eines?

Viele Dokumentationswerkzeuge bieten reichhaltige Schreiberfahrungen, werden aber häufig mit gehosteten Plattformen, proprietären Editoren oder starren Workflows geliefert. Andere bieten leistungsstarke Grundlagen, erwarten aber von Teams, dass sie alles selbst zusammenbauen. Jede Organisation ist anders, und diese Ansätze passen nicht immer.

Mordoc verfolgt einen anderen Ansatz. Es bietet einen Open-Source-Dokumentationsgenerator, der es Teams ermöglicht, Inhalte als Code zu pflegen und sie auf jeder Infrastruktur ihrer Wahl zu veröffentlichen. Mit der bereits eingebauten Dokumentationsapp und den Komponenten können Inhaltsautoren sofort mit einfacher, leicht erlernbarer Syntax beginnen zu schreiben.

So sieht das in der Praxis aus.

Inhalt zuerst, komponentengetrieben

Mordoc wird mit der eingebauten Dokumentationsapp und gängigen Dokumentationskomponenten geliefert, sodass vor dem Schreiben nichts zusammengebaut werden muss. Einmal installiert, können diese Komponenten überall durch klare, lesbare Syntax wiederverwendet werden.

Das bedeutet:

• Inhaltsautoren konzentrieren sich auf Struktur und Klarheit, nicht auf Implementierungsdetails
• Reichhaltige Komponenten wie Karten, Callouts, Code-Blöcke und Tabellen sind einfach zu verwenden
• Die Dokumentation bleibt konsistent über Seiten und Mitwirkende hinweg

Die Syntax ist bewusst begrenzt und vorhersehbar. Sie ist darauf ausgelegt, leicht zu erlernen, leicht zu lesen und langfristig leicht zu pflegen zu sein.

Inhalt als Code

Mordoc behandelt Inhalt als Code, ohne Autoren zu zwingen, wie Entwickler zu denken.

Da Ihre Inhalte in Dateien gespeichert sind:

• Änderungen werden nachverfolgt und können überprüft werden
• Die Versionshistorie ist explizit
• Die Zusammenarbeit skaliert natürlich mit Ihrem Team

Sie erhalten die Vorteile moderner Änderungsverwaltung, während die Schreiberfahrung leichtgewichtig und fokussiert bleibt.

Keine Anbieterabhängigkeit

Ihre Dokumentation gehört Ihnen.

• Überall hosten
• Auf jeder Infrastruktur veröffentlichen
• Jederzeit wechseln, ohne Inhalte neu schreiben zu müssen

Mordoc generiert Dokumentationswebsites. Es sperrt Ihre Inhalte nicht in einer Plattform ein.

Für die Zusammenarbeit entwickelt

Mordoc ist so konzipiert, dass:

• Inhaltsersteller sich auf Schreiben und Struktur konzentrieren
• Entwickler sich nur bei Bedarf auf Einrichtung und Infrastruktur konzentrieren

Diese Trennung der Aufgaben macht Dokumentation einfacher zu skalieren und einfacher zu pflegen.

Open Source by Design

Mordoc ist Open Source und transparent.

• Keine Black Boxes
• Kein verstecktes Verhalten
• Community-getriebene Verbesserungen

Sie können es untersuchen, verstehen, wie es funktioniert, und Ihren Dokumentations-Workflow an Ihre Bedürfnisse anpassen.

Neugierig, wie es funktioniert? Legen wir los.

Nächster Schritt

• Einen Code-Editor installieren. Es ist ein hilfreiches Werkzeug, und Sie müssen nicht programmieren.