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.19 oder neuer und einen docs/-Ordner mit mindestens einer .md- oder .mdx-Datei – mehr ist nicht einzurichten.

Installieren und ausführen

Ein 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, eine Konfigurationsdatei und eine package.json mit den Skripten dev, build und doctor, dazu eine .gitignore, die node_modules/, das generierte .blume/, dist/ und .env.local (wo lokale Secrets hingehören) aus der Versionskontrolle heraushält. Die Abhängigkeiten installiert es mit dem Paketmanager, mit dem du es ausgeführt hast. Übergib --yes, um die Abfragen zu überspringen und die Standardwerte zu übernehmen, oder --no-install, um nur die Dateien zu schreiben.

npx blume init

pnpm dlx blume init

yarn dlx blume init

bunx blume init

nubx blume init

aube dlx blume init

Unter pnpm 12 fügst du --allow-build=esbuild nach pnpm dlx hinzu (pnpm dlx --allow-build=esbuild blume init): pnpm 12 weigert sich, das Installationsskript von esbuild auszuführen, von dem Astro abhängt, solange du es nicht freigibst. Innerhalb eines bestehenden pnpm-Workspaces muss der neue Ordner unter den packages des Workspaces aufgeführt sein (pnpm installiert nichts anderes, daher überspringt init die Installation, bis das der Fall ist), und esbuild benötigt allowBuilds: { esbuild: true } in der pnpm-workspace.yaml des Workspaces; init erinnert dich an beides. Mit Yarn 2 oder neuer schreibt init eine .yarnrc.yml, die Yarn auf eine node_modules-Installation umstellt, die Blume benötigt; unter Yarn 1 führst du npx blume init aus.

docs/
  index.mdx
.gitignore
blume.config.ts
package.json

Den Entwicklungsserver starten

Im Projektverzeichnis generiert Blume die Laufzeitumgebung und stellt deine Doku mit Hot Reload bereit.

npm run dev

pnpm run dev

yarn run dev

bun run dev

nub run dev

aube run dev

Für die Produktion bauen

Statisches HTML wird nach dist/ geschrieben, mit einem darauf aufgebauten lokalen Suchindex.

npm run build

pnpm run build

yarn run build

bun run build

nub run build

aube run build

Du fügst Blume zu einem Projekt hinzu, das bereits eine package.json hat? blume init lässt bestehende Dateien unangetastet und überspringt die Installation, also installiere Blume selbst (npm install blume) und füge dann "dev": "blume dev" und "build": "blume build" zu dessen Skripten hinzu oder führe npx blume dev direkt aus. Die nächsten Schritte, die init ausgibt, enthalten beide Befehle für deinen Paketmanager.

Schreibe 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.

Nächste Schritte

Konfiguration

Passe Titel, Theme, Suche und Deployment an.

Komponenten

Entdecke die integrierte Komponentenbibliothek.

Auffindbarkeit

Liefere llms.txt, Social Cards und einen MCP-Server aus.

Deployment

Geh auf jedem statischen Host live.