Blume 2.0

Blume 2.0

Hayden Bleasel · Rédaction · Programmation

Blume 2.0 est un framework de documentation open source qui transforme un dossier de Markdown en site Astro rapide, avec recherche locale, références d'API et serveur MCP pour les agents.

Aperçu de l'interface de Blume 2.0

À propos de Blume 2.0

About

Qu'est-ce que Blume 2.0

Blume 2.0 est un framework de documentation bâti sur Astro et Vite. Vous déposez des fichiers Markdown ou MDX dans un dossier docs/, vous lancez une commande, et vous obtenez un site avec navigation, recherche, coloration syntaxique et images Open Graph déjà en place. Aucun code applicatif à maintenir, aucun tableau de bord à ouvrir le matin.

La version 2 porte surtout sur la configuration. Recherche, déploiement, sources de contenu, références d'API, analytics et backend de l'assistant deviennent des adaptateurs importés depuis les sous-chemins blume/* et appelés dans blume.config.ts. Les réglages lisibles par machine quittent ai pour une clé agents. Vos pages ne bougent pas : la mise à niveau relève de la config, pas de la réécriture.

Ce qui distingue Blume des autres générateurs, c'est le second public. Chaque site publie llms.txt, une copie Markdown de chaque page, une API JSON en lecture seule et un serveur MCP optionnel, si bien qu'un agent lit la même chose qu'un humain. Cet ensemble fait d'un site de documentation en Markdown une documentation prête pour l'IA. Le revers est net : c'est un outil de développeur, et qui attend un éditeur hébergé avec aperçu visuel tombe sur un dépôt Git.

Premiers pas

  1. Lancez npx blume init dans un dossier vide. La CLI installe les dépendances et ajoute les scripts dev et build au package.json.
  2. Ouvrez blume.config.ts et renseignez le nom du site, l'URL et les adaptateurs de recherche, de déploiement ou d'analytics dont vous avez besoin.
  3. Placez vos fichiers Markdown dans docs/. L'arborescence devient le chemin de l'URL et l'ordre des pages vient des noms de fichiers ou d'un meta.ts.
  4. Démarrez npm run dev pour prévisualiser en local, puis npm run build pour produire la sortie statique.
  5. En option : npx blume migrate <source> --codex confie un site Mintlify, Docusaurus, GitBook ou MkDocs à un agent de code pour la conversion.

Informations sur le produit

Aperçu des tarifs, des plateformes compatibles et des performances de Blume 2.0.

Offre gratuiteOui
Offres payantes$0 (MIT license)
PlateformeWeb, CLI (Node.js 22.19+)
DéveloppeurHayden Bleasel
CatégorieRédaction · Programmation
Date de lancementSep 2026
Dernière mise à jourOct 2026
Visites du site5.3K
Classement mondial du site2.6M
Disponibilité de l’APINon

Idéal pour

Les utilisateurs, tâches et cas d'usage où cet outil convient le mieux.

Utilisateurs

  • Les développeurs qui documentent leur propre produit
  • Les équipes plateforme et API
  • Les mainteneurs de projets open source

Tâches

  • Publier une documentation technique depuis Markdown
  • Rendre la documentation lisible par les agents de code
  • Migrer depuis une autre plateforme

Cas d'usage

  • Une startup dépasse le README
  • Le produit sort en plusieurs langues
  • Le support répond aux mêmes questions chaque semaine

Fonctionnalités clés

Pages Markdown et navigation déduite

Les dossiers deviennent des routes et les noms de fichiers des slugs, donc une nouvelle page est un nouveau fichier. La barre latérale se construit seule à partir de l'arborescence, puis accepte des ajustements via le frontmatter ou un meta.ts placé à côté des pages. Vous pouvez réordonner un groupe, lui donner une icône ou masquer une page sans toucher au fichier de configuration, et le fil d'Ariane comme le sommaire latéral suivent la même structure.

Surface pour agents avec llms.txt et MCP

Chaque site Blume publie llms.txt et une copie .md par route, ce qui permet à un agent de récupérer la source d'une page au lieu de scraper le HTML rendu. Le serveur MCP optionnel expose la recherche et la lecture de pages comme des outils, et le site sert aussi une API JSON de documentation décrite par un document OpenAPI 3.1. Un manifeste dans /.well-known/ai-catalog.json laisse les registres d'agents découvrir le site.

Références d'API depuis le schéma

Blume tient le rôle de générateur de référence API pour les schémas OpenAPI, AsyncAPI ou GraphQL, locaux ou distants. Vous pointez la configuration vers le fichier et obtenez la vue d'ensemble, une page par opération, les paramètres, les corps de requête et les tableaux de réponse. Les exemples de code sortent en 18 langages, de cURL et Python à Go, Ruby et C#. La référence étant construite au build, une modification de schéma apparaît au déploiement suivant.

Recherche locale et assistant dans la page

La recherche fonctionne sans clé d'API grâce à un index local, et gère le chinois, le japonais, le coréen et le thaï, langues qui n'espacent pas les mots. Les sites plus gros peuvent basculer vers Algolia, Typesense, Orama Cloud, Mixedbread ou Pagefind via un adaptateur. Le panneau de l'assistant répond à partir des pages du site, avec des adaptateurs pour Vercel AI Gateway, OpenRouter, LLM Gateway, Inkeep ou tout endpoint compatible OpenAI.

Traduction et documentation versionnée

Les dossiers de locale produisent des routes préfixées, une navigation par langue et des libellés d'interface traduits, et blume translate remplit les langues manquantes. Le versionnement fige un dossier par release, ajoute un sélecteur de version et garde la recherche limitée à la version choisie. Les deux fonctions s'appliquent aussi à la surface pour agents, qui voit donc les mêmes routes qu'un lecteur.

Validation, audit et sortie vers Astro

blume validate vérifie les liens, les ancres et le frontmatter avant un déploiement. blume audit lit le HTML produit et signale les problèmes de SEO avec le fichier et la ligne d'origine. blume eval lance un agent lecteur et un agent juge sur la documentation pour vérifier que les réponses se trouvent vraiment. Si le framework devient trop étroit, blume eject transforme le projet caché en application Astro autonome qui vous appartient.

Avantages et inconvénients

Avantages

  • La licence MIT couvre éditeurs, pages et trafic sans limite, donc la dépense reste dans l'hébergement et dans les jetons du modèle que vous choisissez.
  • Démarrage sans configuration : `npx blume init` donne un site avec recherche, navigation et images OG avant même la première ligne de config.
  • La surface pour agents est intégrée plutôt qu'ajoutée après coup, ce qui épargne le travail `llms.txt` et MCP dont presque toutes les équipes doc ont besoin aujourd'hui.
  • Les adaptateurs couvrent les choix ingrats, d'Algolia et Typesense à Vercel, Netlify, Cloudflare, PostHog et Plausible.
  • Les contrôles en CLI et `eject` offrent une porte de sortie, donc le framework n'est pas un piège.

Inconvénients

  • Blume 2.0 casse la configuration précédente. Un projet qui définissait recherche, déploiement, sources ou assistant doit réécrire ces blocs en appels d'adaptateurs, et une grosse config prend une après-midi.
  • Il n'y a ni éditeur ni tableau de bord hébergé. Les rédacteurs qui ne connaissent pas Git dépendent des développeurs ou d'une source CMS, ce qui coûte cher aux équipes marketing.
  • Node.js 22.19 ou plus récent est requis, donc les images CI anciennes échouent jusqu'à la mise à jour du runtime.
  • Les fonctions IA sont facturées chez le fournisseur du modèle. Le framework est gratuit, mais un assistant très sollicité ou la narration ajoutent un coût mensuel variable.

Questions fréquentes

Blume 2.0 est la deuxième version majeure d'un framework de documentation open source pour Astro. Il génère un site à partir de fichiers Markdown ou MDX et y ajoute recherche, références d'API, traduction, versionnement et une surface lisible par les agents.