Blume ist ein Open-Source-Dokumentations-Framework, das auf Markdown basiert und darauf ausgelegt ist, produktionsreife Websites ohne Konfigurationsaufwand zu erstellen, ergänzt durch integrierte KI-Funktionen und interaktive API-Referenzen.
Funktion und offizielle Positionierung des Produkts
Blume vereinfacht die Erstellung von Dokumentations-Websites, indem es Benutzern ermöglicht, Inhalte direkt aus Markdown-Dateien zu veröffentlichen. Es automatisiert wichtige Funktionen wie Navigation, SEO und Suche, sodass sich Entwickler auf den Inhalt statt auf die Wartung von Boilerplate-Code konzentrieren können.
Die Plattform ist sowohl für menschliche Leser als auch für maschinelle Agenten konzipiert und bietet native Unterstützung für LLM-freundliche Formate wie llms.txt und MCP-Server. Sie bietet eine umfassende Suite von Komponenten und ein CLI-Toolset zur Verwaltung des gesamten Dokumentationslebenszyklus.
Durch offizielle Quellen belegte Anwendungsfälle
Erstellen Sie umfassende, durchsuchbare und interaktive Dokumentationsseiten für Softwareprojekte und Entwicklertools.
Generieren Sie interaktive API-Referenzseiten aus OpenAPI- oder AsyncAPI-Spezifikationen mit integrierten Testumgebungen.
Der dokumentierte Ablauf, sofern verfügbar
Führen Sie den Befehl npx blume init aus, um ein neues Dokumentationsprojekt mit den erforderlichen Konfigurationsdateien zu erstellen.
Legen Sie Markdown- oder MDX-Dateien in den Projektordner, um automatisch die Seitennavigation und die Seitenstruktur zu generieren.
Blume wurde entwickelt, um die Lücke zwischen menschenlesbarer Dokumentation und maschinell zugänglichem Wissen zu schließen. Durch die automatische Generierung maschinenlesbarer Indizes und den Zugriff auf rohes Markdown unter jeder URL ist das Tool so konzipiert, dass KI-Modelle und Coding-Agents den Dokumentationskorpus präzise interpretieren und nutzen können.
Prüfungen mit eigenen Inhalten und Arbeitsabläufen
Welche Quellen wann geprüft wurden
Antworten auf Basis des quellengeprüften Produkteintrags
Nein, Blume ist auf Zero-Config ausgelegt. Ein einfacher Ordner mit Markdown-Dateien dient als vollständiges Projekt, und die Navigation wird automatisch aus Ihrer Dateistruktur abgeleitet.
Ja, Blume unterstützt mehrere Inhaltsquellen. Sie können das Framework so konfigurieren, dass Inhalte aus Remote-Repositorys, CMS-Plattformen oder benutzerdefinierten Backends über die Inhaltsquellen-Konfiguration abgerufen werden.
Blume unterstützt interaktive API-Referenzen durch die Akzeptanz von OpenAPI- oder AsyncAPI-Spezifikationen. Diese werden in Dokumentationsseiten gerendert, die Schemata und eine Live-Testumgebung enthalten.
Ja, Blume unterstützt die Internationalisierung für bis zu 36 Sprachen, einschließlich voller Unterstützung für Rechts-nach-Links-Sprachen, sodass Ihre Dokumentation eine globale Nutzerbasis erreichen kann.
Blume enthält eine integrierte CLI, die Wartungsaufgaben wie das Validieren von Links, das Überprüfen der SEO-Leistung, das Bewerten der Dokumentationsqualität und das Verwalten von Übersetzungsaktualisierungen automatisiert.
