Schnellstart
Installiere Blume, erstelle ein neues Projekt und veröffentliche deine erste Dokumentationsseite in wenigen Minuten – und baue sie in deinem eigenen Tempo zu einer vollständigen Website aus.
Von einem leeren Ordner zu einer laufenden Doku-Website in wenigen Befehlen. Blume benötigt Node.js 22.12 oder neuer und einen docs/-Ordner mit mindestens einer .md- oder .mdx-Datei – mehr ist nicht einzurichten.
Installieren und ausführen
Blume installieren
Füge das Paket zu einem neuen oder bestehenden Projekt hinzu.
npm install blumepnpm add blumeyarn add blumebun add blumeEin Projekt erstellen
blume init stellt ein paar Fragen – wo das Projekt erstellt werden soll, wie deine
Doku-Website heißt, welches Template verwendet wird und wo deine Inhalte liegen – und
erzeugt dann das Nötigste: einen Inhaltsordner und eine Konfigurationsdatei. Übergib
--yes, um die Abfragen zu überspringen und die Standardwerte zu übernehmen.
blume initdocs/
index.mdx
blume.config.tsDen Entwicklungsserver starten
Blume generiert die Laufzeitumgebung und stellt deine Doku mit Hot Reload bereit.
blume devFür die Produktion bauen
Statisches HTML wird nach dist/ geschrieben, mit einem darauf aufgebauten lokalen Suchindex.
blume buildSchreibe deine erste Seite
Jede Seite ist Markdown oder MDX mit ein wenig Frontmatter – title und description werden automatisch als Seitenüberschrift und Einleitung gerendert. Füge dies in docs/index.mdx ein:
---
title: Introduction
description: Welcome to my docs.
---
Welcome! Use **Markdown** and built-in components — no imports required:
:::note
Blume ships callouts, cards, tabs, steps, and more.
:::Speichere sie, und der Entwicklungsserver lädt sofort neu. Navigation, Suche und Seiten-Metadaten werden aus deinen Dateien abgeleitet, sobald du sie hinzufügst – schreib einfach weiter, und die Website zieht mit.